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

{robotframework-robotlog2rqm-1.4.2 → robotframework_robotlog2rqm-1.6.0}/PKG-INFO

@@ -1,12 +1,10 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: robotframework-robotlog2rqm
-Version: 1.4.2
+Version: 1.6.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
 Author-email: Ngoan.TranDuy@vn.bosch.com
-License: UNKNOWN
-Platform: UNKNOWN
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
@@ -16,6 +14,20 @@ Classifier: Topic :: Software Development
 Requires-Python: >=3.0
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: lxml
+Requires-Dist: requests
+Requires-Dist: colorama
+Requires-Dist: robotframework
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # RobotLog2RQM Description
 
@@ -125,15 +137,15 @@ Use below command to get tools\'s usage:
 
 The usage should be showed as below:
 
-    usage: RobotLog2RQM (RobotXMLResult to RQM importer) [-h] [-v] [--testsuite TESTSUITE] [--recursive] 
-                [--createmissing] [--updatetestcase] [--dryrun] [--stream STREAM] [--baseline BASELINE] 
+    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 
+    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.
@@ -145,19 +157,19 @@ The usage should be showed as below:
     -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 ID for this execution. If 'new', then create a new
                             testsuite for this execution.
-    --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.
-    --stream STREAM       project stream. Note, requires Configuration Management (CM) 
+    --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), 
+    --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
@@ -209,6 +221,58 @@ Then, open RQM with your favourite browser and you will see that the
 test case execution records and their results are imported in the given
 testplan ID.
 
+# RQMTool Submodule
+
+The package now includes a submodule **RQMTool** which provides a
+standalone CLI to fetch test cases and test suites from IBM RQM test
+plans.
+
+RQMTool is accessible as a Python module:
+
+    python -m RobotLog2RQM.rqmtool --host <RQM_SERVER_URL> --project <PROJECT_AREA> \
+                                   --user <USERNAME> --password <PASSWORD> \
+                                   --testplan <TESTPLAN_ID> [--types <artifact_types>] \
+                                   [--format <csv|json>] [--output-dir <DIR>] \
+                                   [--basename <BASENAME>] [--dryrun]
+
+Main features:
+
+-   Fetches selected artifact types ([testcase]{.title-ref} or
+    [testsuite]{.title-ref}) from a given test plan.
+-   Supports CSV or JSON export, with automatic filenames including the
+    test plan ID.
+
+## How to use RQMTool
+
+RQMTool requires RQM information (host URL, project, credentials) and a
+test plan ID. Use the [-h]{.title-ref} argument to see full usage:
+
+    python -m RobotLog2RQM.rqmtool -h
+
+This will display all available command line options for RQMTool, such
+as:
+
+-   [\--types]{.title-ref} : artifact types to fetch
+    ([testcase]{.title-ref}, [testsuite]{.title-ref}). Default: both.
+-   \`\--format\`: output format, either [csv]{.title-ref} or
+    [json]{.title-ref}.
+-   \`\--output-dir\`: directory to save exported files.
+-   \`\--basename\`: base name for output files.
+-   \`\--dryrun\`: validate inputs and RQM login without fetching data.
+
+## Example
+
+Fetch all test cases and test suites from test plan ID 720 and export to
+CSV:
+
+    python -m RobotLog2RQM.rqmtool --host https://sample-rqm-host.com \
+                                   --project ROBFW-AIO \
+                                   --user test_user \
+                                   --password test_pw \
+                                   --testplan 720 \
+                                   --types testcase,testsuite \
+                                   --format csv
+
 ### Sourcecode Documentation
 
 To understand more detail about the tool\'s features and how Robot test
@@ -256,5 +320,3 @@ distributed under the License is distributed on an \"AS IS\" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
-
-

{robotframework-robotlog2rqm-1.4.2 → robotframework_robotlog2rqm-1.6.0}/README.rst

@@ -112,15 +112,15 @@ The usage should be showed as below:
 
 ::
 
-   usage: RobotLog2RQM (RobotXMLResult to RQM importer) [-h] [-v] [--testsuite TESTSUITE] [--recursive] 
-               [--createmissing] [--updatetestcase] [--dryrun] [--stream STREAM] [--baseline BASELINE] 
+   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 
+   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.
@@ -132,19 +132,19 @@ The usage should be showed as below:
    -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 ID for this execution. If 'new', then create a new
                            testsuite for this execution.
-   --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.
-   --stream STREAM       project stream. Note, requires Configuration Management (CM) 
+   --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), 
+   --baseline BASELINE   project baseline. Note, requires Configuration Management (CM),
                          or Baselines Only to be enabled for the project area.
 
 
@@ -203,6 +203,60 @@ at ``https://sample-rqm-host.com``
 Then, open RQM with your favourite browser and you will see that the test case
 execution records and their results are imported in the given testplan ID.
 
+RQMTool Submodule
+=================
+
+The package now includes a submodule **RQMTool** which provides a standalone CLI to fetch test cases
+and test suites from IBM RQM test plans.
+
+RQMTool is accessible as a Python module:
+
+::
+
+    python -m RobotLog2RQM.rqmtool --host <RQM_SERVER_URL> --project <PROJECT_AREA> \
+                                   --user <USERNAME> --password <PASSWORD> \
+                                   --testplan <TESTPLAN_ID> [--types <artifact_types>] \
+                                   [--format <csv|json>] [--output-dir <DIR>] \
+                                   [--basename <BASENAME>] [--dryrun]
+
+Main features:
+
+* Fetches selected artifact types (`testcase` or `testsuite`) from a given test plan.
+* Supports CSV or JSON export, with automatic filenames including the test plan ID.
+
+How to use RQMTool
+------------------
+
+RQMTool requires RQM information (host URL, project, credentials) and a test plan ID.
+Use the `-h` argument to see full usage:
+
+::
+
+    python -m RobotLog2RQM.rqmtool -h
+
+This will display all available command line options for RQMTool, such as:
+
+* `--types` : artifact types to fetch (`testcase`, `testsuite`). Default: both.
+* `--format`: output format, either `csv` or `json`.
+* `--output-dir`: directory to save exported files.
+* `--basename`: base name for output files.
+* `--dryrun`: validate inputs and RQM login without fetching data.
+
+Example
+-------
+
+Fetch all test cases and test suites from test plan ID 720 and export to CSV:
+
+::
+
+    python -m RobotLog2RQM.rqmtool --host https://sample-rqm-host.com \
+                                   --project ROBFW-AIO \
+                                   --user test_user \
+                                   --password test_pw \
+                                   --testplan 720 \
+                                   --types testcase,testsuite \
+                                   --format csv
+
 Sourcecode Documentation
 ~~~~~~~~~~~~~~~~~~~~~~~~
 

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

@@ -308,9 +308,9 @@ Disconnect from RQM.
       """
       self.session.close()
 
-   def config(self, plan_id, build_name=None, config_name=None,
+   def config(self, plan_id=None, build_name=None, config_name=None,
               createmissing=False, updatetestcase=False, suite_id=None,
-              stream=None, baseline=None, naming_convention=None):
+              stream=None, baseline=None, naming_convention=None, fetch_team_areas=True):
       """
 Configure RQMClient with testplan ID, build, configuration, createmissing, ...
 
@@ -322,7 +322,7 @@ Configure RQMClient with testplan ID, build, configuration, createmissing, ...
 
 *  ``plan_id``
 
-   / *Condition*: required / *Type*: str /
+   / *Condition*: optional / *Type*: str /
 
    Testplan ID of RQM project for importing result(s).
 
@@ -352,12 +352,36 @@ Configure RQMClient with testplan ID, build, configuration, createmissing, ...
 
    If `True`, the information of testcase on RQM will be updated bases on robot testfile.
 
-*  ``suite_id (optional)``
+*  ``suite_id``
 
    / *Condition*: optional / *Type*: str / *Default*: None /
 
    Testsuite ID of RQM project for importing result(s).
 
+*  ``stream``
+
+   / *Condition*: optional / *Type*: str / *Default*: None /
+
+   Project stream which is enabled in Configuration Management (CM).
+
+*  ``baseline``
+
+   / *Condition*: optional / *Type*: str / *Default*: None /
+
+   Project baseline which is enabled in Configuration Management (CM).
+
+*  ``naming_convention``
+
+   / *Condition*: optional / *Type*: dict / *Default*: None /
+
+   Naming convention for the creating new resources (testcase, TCER, ...).
+
+*  ``fetch_team_areas``
+
+   / *Condition*: optional / *Type*: bool / *Default*: True /
+
+   If `True`, fetch team-areas information for further process.
+
 **Returns:**
 
 (*no returns*)
@@ -411,12 +435,13 @@ Configure RQMClient with testplan ID, build, configuration, createmissing, ...
                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:
-            raise Exception('Testplan with ID %s is not existing!'%str(plan_id))
+         if plan_id != None:
+            res_plan = self.getResourceByID('testplan', plan_id)
+            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
+            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:
@@ -453,7 +478,8 @@ Configure RQMClient with testplan ID, build, configuration, createmissing, ...
             self.testsuite.name  = oTestsuite.find('ns4:title', oTestsuite.getroot().nsmap).text
 
          # get all team-areas for testcase template
-         self.getAllTeamAreas()
+         if fetch_team_areas:
+            self.getAllTeamAreas()
 
 
       except Exception as error:
@@ -680,6 +706,54 @@ Return the name for given resource bases on the naming convention
       except:
          raise Exception(f"Failed to generate name for {resource} '{name}'")
 
+   def __parse_test_artifact(self, xml_data):
+      """
+Parse XML test case response and extract its data.
+
+**Arguments:**
+
+*  ``xml_data``
+
+   / *Condition*: required / *Type*: str /
+
+   The response text from request to get test case as xml string.
+
+**Returns:**
+
+* / *Type*: dict /
+
+  The dictionary which contains the parsed data from given xml.
+
+  .. code:: python
+
+      {
+         'id': ...,
+         'name': ...,
+         'url': ...,
+         ...
+      }
+
+      """
+      test_tree = get_xml_tree(BytesIO(str(xml_data).encode()), bdtd_validation=False)
+      nsmap = test_tree.getroot().nsmap
+
+      test_name = test_tree.find('ns4:title', test_tree.getroot().nsmap)
+      test_web_id = test_tree.find('ns2:webId', test_tree.getroot().nsmap)
+      test_url = test_tree.find('ns4:identifier', test_tree.getroot().nsmap)
+      test_category = test_tree.findall('ns2:category', test_tree.getroot().nsmap)
+      test_custom_attr = test_tree.findall('.//ns2:customAttribute', test_tree.getroot().nsmap)
+      test_data = {'id': test_web_id.text,
+                                    'name': test_name.text if test_name is not None else '',
+                                    'url': test_url.text}
+      for item in test_category:
+         test_data[item.attrib.get('term')] = item.attrib.get('value')
+      for attr in test_custom_attr:
+         try:
+            test_data[attr.find("ns2:name", nsmap).text] = attr.find("ns2:value", nsmap).text
+         except:
+            pass
+
+      return test_data
    #
    #  Methods to get resources
    #
@@ -849,6 +923,91 @@ Example:
       else:
          raise Exception(f"Could not get 'team-areas' of project '{self.projectname}'.")
 
+   def getTestArtifactsFromResource(self, resource_type, resource_id, artifact_types):
+      """
+Get all test cases and test suites associated with a given test plan.
+
+**Arguments:**
+
+*  ``resource_type``
+
+   / *Condition*: required / *Type*: str /
+
+   The RQM test resource (`testplan` or `testsuite`) to get test artifact(s).
+
+*  ``resource_id``
+
+   / *Condition*: required / *Type*: str /
+
+   The RQM test plan/suite to get test artifact(s).
+
+*  ``artifact_types``
+
+   / *Condition*: required / *Type*: list /
+
+   List of artifact types (`testcase`, `testsuite`) for fetching.
+
+**Returns:**
+
+* / *Type*: dict /
+
+  A dictionary containing fetched artifacts:
+
+  .. code:: python
+
+     {
+        'testcase': [{'id': ..., 'name': ..., 'url': ...}, ...],
+        'testsuite': [{'id': ..., 'name': ..., 'url': ...}, ...]
+     }
+      """
+      ALLOW_RESOURCE_TYPES = ['testplan', 'testsuite']
+      ALLOW_ARTIFACT_TYPES = ['testcase', 'testsuite']
+      result = {}
+
+      if resource_type not in ALLOW_RESOURCE_TYPES:
+         raise ValueError(
+            f"Unsupported resource type '{resource_type}'. "
+            f"Please use one of the following: {', '.join(ALLOW_RESOURCE_TYPES)}."
+         )
+
+      if isinstance(artifact_types, str):
+         artifact_types = [artifact_types]
+      elif not isinstance(artifact_types, (list, tuple)):
+         raise TypeError(
+               f"Invalid type for 'artifact_types': expected str or list, got {type(artifact_types).__name__}."
+         )
+
+      for item in artifact_types:
+         artifact_type = item.lower()
+         if artifact_type not in ALLOW_ARTIFACT_TYPES:
+            raise ValueError(
+               f"Unsupported artifact type '{artifact_type}'. "
+               f"Please use one of the following: {', '.join(ALLOW_ARTIFACT_TYPES)}."
+            )
+         result[artifact_type] = []
+
+      res = self.getResourceByID(resource_type, resource_id)
+      if res.status_code != 200:
+         raise Exception(f"Failed to get {resource_type} {resource_id}: {res.reason}")
+
+      oTree = get_xml_tree(BytesIO(str(res.text).encode()), bdtd_validation=False)
+      root = oTree.getroot()
+      nsmap = root.nsmap
+
+      for item in artifact_types:
+         artifact_type = item.lower()
+         # Find all linked test artifact
+         for oTest in root.findall(f'.//ns2:{artifact_type}', nsmap):
+            href = oTest.attrib.get('href')
+            if href:
+               test_id = href.split('/')[-1]
+               # Get testcase/testsuite by ID
+               test_res = self.getResourceByID(artifact_type, test_id)
+               if test_res.status_code == 200:
+                  test_data = self.__parse_test_artifact(test_res.text)
+                  result[artifact_type].append(test_data)
+
+      return result
 
    #
    #  Methods to create XML template for resources

robotframework_robotlog2rqm-1.6.0/RobotLog2RQM/logger.py

@@ -0,0 +1,180 @@
+#  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.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+# ******************************************************************************
+#
+# File: logging.py
+#
+# Initially created by Tran Duy Ngoan(RBVH/EMC51) / October 2025
+#
+# Logging class
+#
+# History:
+#
+# 2025-10-20:
+#  - initial version
+#
+# ******************************************************************************
+import sys
+import colorama as col
+import os
+
+class Logger():
+   """
+Logger class for logging message.
+   """
+   output_logfile = None
+   output_console = True
+   color_normal   = col.Fore.WHITE + col.Style.NORMAL
+   color_error    = col.Fore.RED + col.Style.BRIGHT
+   color_warn     = col.Fore.YELLOW + col.Style.BRIGHT
+   color_reset    = col.Style.RESET_ALL + col.Fore.RESET + col.Back.RESET
+   prefix_warn    = "WARN: "
+   prefix_error   = "ERROR: "
+   prefix_fatalerror = "FATAL ERROR: "
+   prefix_all = ""
+   dryrun = False
+
+   @classmethod
+   def config(cls, output_console=True, output_logfile=None, dryrun=False):
+      """
+Configure Logger class.
+
+**Arguments:**
+
+*  ``output_console``
+
+   / *Condition*: optional / *Type*: bool / *Default*: True /
+
+   Write message to console output.
+
+*  ``output_logfile``
+
+   / *Condition*: optional / *Type*: str / *Default*: None /
+
+   Path to log file output.
+
+*  ``dryrun``
+
+   / *Condition*: optional / *Type*: bool / *Default*: True /
+
+   If set, a prefix as 'dryrun' is added for all messages.
+
+**Returns:**
+
+(*no returns*)
+      """
+      cls.output_console = output_console
+      cls.output_logfile = output_logfile
+      cls.dryrun = dryrun
+      if cls.dryrun:
+         cls.prefix_all = cls.color_warn + "DRYRUN  " + cls.color_reset
+
+   @classmethod
+   def log(cls, msg='', color=None, indent=0):
+      """
+Write log message to console/file output.
+
+**Arguments:**
+
+*  ``msg``
+
+   / *Condition*: optional / *Type*: str / *Default*: '' /
+
+   Message which is written to output.
+
+*  ``color``
+
+   / *Condition*: optional / *Type*: str / *Default*: None /
+
+   Color style for the message.
+
+*  ``indent``
+
+   / *Condition*: optional / *Type*: int / *Default*: 0 /
+
+   Offset indent.
+
+**Returns:**
+
+(*no returns*)
+      """
+      if color is None:
+         color = cls.color_normal
+      if cls.output_console:
+         print(cls.prefix_all + cls.color_reset + color + " "*indent + msg + cls.color_reset)
+      if cls.output_logfile is not None and os.path.isfile(cls.output_logfile):
+         with open(cls.output_logfile, 'a') as f:
+            f.write(" "*indent + msg)
+      return
+
+   @classmethod
+   def log_warning(cls, msg, indent=0):
+      """
+Write warning message to console/file output.
+
+**Arguments:**
+
+*  ``msg``
+
+   / *Condition*: required / *Type*: str /
+
+   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, indent)
+
+   @classmethod
+   def log_error(cls, msg, fatal_error=False, indent=0):
+      """
+Write error message to console/file output.
+
+*  ``msg``
+
+   / *Condition*: required / *Type*: str /
+
+   Error message which is written to output.
+
+*  ``fatal_error``
+
+   / *Condition*: optional / *Type*: bool / *Default*: False /
+
+   If set, tool will terminate after logging error message.
+
+*  ``indent``
+
+   / *Condition*: optional / *Type*: int / *Default*: 0 /
+
+   Offset indent.
+
+**Returns:**
+
+(*no returns*)
+      """
+      prefix = cls.prefix_error
+      if fatal_error:
+         prefix = cls.prefix_fatalerror
+
+      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)