robotframework-robotlog2rqm 1.4.1__tar.gz → 1.5.0__tar.gz

{robotframework-robotlog2rqm-1.4.1 → robotframework_robotlog2rqm-1.5.0}/PKG-INFO

@@ -1,12 +1,10 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: robotframework-robotlog2rqm
-Version: 1.4.1
+Version: 1.5.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,9 +14,22 @@ Classifier: Topic :: Software Development
 Requires-Python: >=3.0
 Description-Content-Type: text/markdown
 License-File: LICENSE
-
-RobotLog2RQM Description
-========================
+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
 
 The Python package **RobotLog2RQM** provides ability to import [Robot
 Framework test
@@ -38,14 +49,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 +67,7 @@ How to install
     -   Clone the **robotframework-robotlog2rqm** repository to your
         machine.
 
-        ``` {.}
+        ``` 
         git clone https://github.com/test-fullautomation/robotframework-robotlog2rqm.git
         ```
 
@@ -72,7 +82,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 +101,7 @@ How to install
         to find **LaTeX**. This is defined in the **GenPackageDoc**
         configuration file
 
-        ``` {.}
+        ``` 
         packagedoc\packagedoc_config.json
         ```
 
@@ -103,7 +113,7 @@ How to install
 
     -   Use the following command to install **RobotLog2RQM**:
 
-        ``` {.}
+        ``` 
         python setup.py install
         ```
 
@@ -114,8 +124,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,
@@ -128,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.
@@ -148,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
@@ -212,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
@@ -219,8 +280,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 +288,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 +304,7 @@ Contributors
 
 [Holger Queckenstedt](mailto:Holger.Queckenstedt@de.bosch.com)
 
-License
--------
+## License
 
 Copyright 2020-2024 Robert Bosch GmbH
 
@@ -263,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.1 → robotframework_robotlog2rqm-1.5.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.1 → robotframework_robotlog2rqm-1.5.0}/RobotLog2RQM/CRQM.py

@@ -147,7 +147,7 @@ Resource type mapping:
       "testresult"  : "Execution result: {testcase}",
       "testsuite"   : "{testsuite}",
       "tser"        : "TSER: {testsuite}",
-      "suiteresult" : "Testsuite result: {testsuite}"  
+      "suiteresult" : "Testsuite result: {testsuite}"
    }
 
    def __init__(self, user, password, project, host):
@@ -309,7 +309,7 @@ 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, naming_convention=None):
       """
 Configure RQMClient with testplan ID, build, configuration, createmissing, ...
@@ -371,7 +371,7 @@ Configure RQMClient with testplan ID, build, configuration, createmissing, ...
          self.updatetestcase = updatetestcase
          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')
@@ -386,7 +386,7 @@ Configure RQMClient with testplan ID, build, configuration, createmissing, ...
                      self.headers['Configuration-Context'] = stream_id
                      self.session.headers = self.headers
                      break
-               
+
                if not bFoundStream:
                   raise Exception(f"Cannot found given stream '{stream}'")
             else:
@@ -404,7 +404,7 @@ Configure RQMClient with testplan ID, build, configuration, createmissing, ...
                      self.headers['Configuration-Context'] = baseline_id
                      self.session.headers = self.headers
                      break
-               
+
                if not bFoundBaseline:
                   raise Exception(f"Cannot found given baseline '{baseline}'")
             else:
@@ -454,7 +454,7 @@ Configure RQMClient with testplan ID, build, configuration, createmissing, ...
 
          # get all team-areas for testcase template
          self.getAllTeamAreas()
-         
+
 
       except Exception as error:
          raise Exception('Configure RQMClient failed: %s'%error)
@@ -849,6 +849,83 @@ Example:
       else:
          raise Exception(f"Could not get 'team-areas' of project '{self.projectname}'.")
 
+   def getTestsFromTestplan(self, testplan_id, artifact_types):
+      """
+Get all test cases and test suites associated with a given test plan.
+
+**Arguments:**
+
+*  ``testplan_id``
+
+   / *Condition*: required / *Type*: str /
+
+   The RQM test plan 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_ARTIFACT_TYPES = ['testcase', 'testsuite']
+      result = {}
+
+      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('testplan', testplan_id)
+      if res.status_code != 200:
+         raise Exception(f"Failed to get testplan {testplan_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 name
+               test_res = self.getResourceByID(artifact_type, test_id)
+               if test_res.status_code == 200:
+                  test_tree = get_xml_tree(BytesIO(str(test_res.text).encode()), bdtd_validation=False)
+                  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)
+                  result[artifact_type].append({'id': test_web_id.text,
+                                                'name': test_name.text if test_name is not None else '',
+                                                'url': test_url.text})
+
+      return result
 
    #
    #  Methods to create XML template for resources
@@ -1096,7 +1173,7 @@ Return testcase execution record template from provided information.
       nsmap = root.nsmap
       # prepare required data for template
       TCERTittle  = self.__genResourceName('tcer', testcaseName)
-      
+
 
       # Check tcid is internalid or externalid
       testcaseURL = self.integrationURL('testcase', testcaseID)
@@ -1462,7 +1539,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.
 
@@ -1581,7 +1658,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)
@@ -1599,6 +1676,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