robotframework-robotlog2rqm 1.5.0__py3-none-any.whl → 1.6.0__py3-none-any.whl

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,17 +923,23 @@ Example:
       else:
          raise Exception(f"Could not get 'team-areas' of project '{self.projectname}'.")
 
-   def getTestsFromTestplan(self, testplan_id, artifact_types):
+   def getTestArtifactsFromResource(self, resource_type, resource_id, artifact_types):
       """
 Get all test cases and test suites associated with a given test plan.
 
 **Arguments:**
 
-*  ``testplan_id``
+*  ``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 to get test artifact(s).
+   The RQM test plan/suite to get test artifact(s).
 
 *  ``artifact_types``
 
@@ -880,9 +960,16 @@ Get all test cases and test suites associated with a given test plan.
         '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)):
@@ -899,9 +986,9 @@ Get all test cases and test suites associated with a given test plan.
             )
          result[artifact_type] = []
 
-      res = self.getResourceByID('testplan', testplan_id)
+      res = self.getResourceByID(resource_type, resource_id)
       if res.status_code != 200:
-         raise Exception(f"Failed to get testplan {testplan_id}: {res.reason}")
+         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()
@@ -914,16 +1001,11 @@ Get all test cases and test suites associated with a given test plan.
             href = oTest.attrib.get('href')
             if href:
                test_id = href.split('/')[-1]
-               # Get testcase name
+               # Get testcase/testsuite by ID
                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})
+                  test_data = self.__parse_test_artifact(test_res.text)
+                  result[artifact_type].append(test_data)
 
       return result
 

RobotLog2RQM/robotlog2rqm.py

@@ -225,7 +225,7 @@ Default schema supports below information:
          # 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])
+         oMatch = re.search(r".*\{(.*)\}.*", 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")

RobotLog2RQM/rqmtool.py

@@ -83,11 +83,26 @@ Process provided argument(s) from command line.
       required=True,
       help="RQM password."
    )
-   parser.add_argument(
+   # exclusive group to provdve only --testsuite or --testplan
+   group = parser.add_mutually_exclusive_group(required=True)
+   group.add_argument(
       "--testplan",
-      required=True,
       help="RQM testplan ID."
    )
+   group.add_argument(
+      "--testsuite",
+      help="RQM testsuite ID."
+   )
+   parser.add_argument(
+      "--stream",
+      type=str,
+      help="project stream. Note, requires Configuration Management (CM) to be enabled for the project area."
+   )
+   parser.add_argument(
+      '--baseline',
+      type=str,
+      help='project baseline. Note, requires Configuration Management (CM), or Baselines Only to be enabled for the project area.'
+   )
    parser.add_argument(
       "--dryrun",
       action="store_true",
@@ -264,6 +279,56 @@ Write data to output files (JSON or CSV) according to specified options.
          file_name = os.path.join(output_dir, f"{basename}_{artifact_type}s.csv")
          write_csv_file(file_name, data, artifact_type)
 
+def normalize_custom_attributes(data, artifact_types):
+   """
+Ensure all artifacts across projects have consistent keys.
+Missing custom attributes will be filled with empty strings.
+
+**Arguments:**
+
+*  ``data``
+
+   / *Condition*: required / *Type*: dict /
+
+   Dictionary containing artifact data fetched from RQM, where each key represents
+   an artifact type (e.g., ``testcase``, ``testsuite``) and the value is a list
+   of dictionaries holding artifact details.
+
+*  ``artifact_types``
+
+   / *Condition*: required / *Type*: list /
+
+   List of artifact types to process (e.g., ``['testcase', 'testsuite']``).
+   Each type key in ``data`` will be normalized to ensure all items have the same set of attributes.
+
+**Returns:**
+
+*  ``data``
+
+   / *Type*: dict /
+
+   Normalized dictionary with consistent keys across all artifacts.
+   Any missing custom attributes are added with an empty string ("") as value.
+   """
+   for artifact_type in artifact_types:
+      artifacts = data.get(artifact_type, [])
+      if not artifacts:
+         continue
+
+      # Collect all keys (standard + custom attributes)
+      all_keys = set()
+      for item in artifacts:
+         all_keys.update(item.keys())
+
+      # Fill missing attributes with empty string
+      for item in artifacts:
+         for key in all_keys:
+               if key not in item:
+                  item[key] = ""
+
+   return data
+
+
 def RQMTool():
    """
 Main entry point for RQMTool CLI.
@@ -283,6 +348,7 @@ Main entry point for RQMTool CLI.
    RQMClient = CRQMClient(args.user, args.password, args.project, args.host)
    try:
       bSuccess = RQMClient.login()
+      RQMClient.config(stream=args.stream, baseline=args.baseline)
       if bSuccess:
          Logger.log()
          Logger.log(f"Login RQM as user '{args.user}' successfully!")
@@ -292,20 +358,30 @@ Main entry point for RQMTool CLI.
       Logger.log_error(f"Could not login to RQM: '{str(reason)}'.")
 
    if not args.dryrun:
-      testplan_data = RQMClient.getTestsFromTestplan(args.testplan, args.types)
-
-      basename_with_id = f"{args.basename}_{args.testplan}"
+      if args.testplan:
+         artifact_types = args.types
+         basename_with_id = f"{args.basename}_{args.testplan}"
+         test_data = RQMClient.getTestArtifactsFromResource('testplan', args.testplan, args.types)
+         test_data = normalize_custom_attributes(test_data, artifact_types)
+      elif args.testsuite:
+         artifact_types = ['testcase']
+         if args.basename == "testplan_export":
+            basename_with_id = f"testsuite_export_{args.testsuite}"
+         else:
+            basename_with_id = f"{args.basename}_{args.testsuite}"
+         test_data = RQMClient.getTestArtifactsFromResource('testsuite', args.testsuite, artifact_types)
+         test_data = normalize_custom_attributes(test_data, artifact_types)
 
       write_output_file(
-         testplan_data,
+         test_data,
          output_dir=args.output_dir,
          basename=basename_with_id,
          extension=args.format,
-         artifact_types=args.types
+         artifact_types=artifact_types
       )
 
-      for artifact_type in args.types:
-         items = testplan_data.get(artifact_type, [])
+      for artifact_type in artifact_types:
+         items = test_data.get(artifact_type, [])
          Logger.log(f"Found {len(items)} {artifact_type}(s)")
          cnt = 1
          for item in items:

RobotLog2RQM/version.py

@@ -18,5 +18,5 @@
 #
 # Version and date of RobotLog2RQM
 #
-VERSION      = "1.5.0"
-VERSION_DATE = "28.10.2025"
+VERSION      = "1.6.0"
+VERSION_DATE = "10.11.2025"

{robotframework_robotlog2rqm-1.5.0.dist-info → robotframework_robotlog2rqm-1.6.0.dist-info}/METADATA

@@ -1,12 +1,10 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: robotframework-robotlog2rqm
-Version: 1.5.0
+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
@@ -20,6 +18,16 @@ 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
 
@@ -312,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.5.0.dist-info → robotframework_robotlog2rqm-1.6.0.dist-info}/RECORD

@@ -1,11 +1,11 @@
-RobotLog2RQM/CRQM.py,sha256=TsgEXYu608vb-rjQ9qTbxzql_EPTgVHqnrdkDs3rAus,67139
-RobotLog2RQM/RobotLog2RQM.pdf,sha256=Ujot_99PiYu2s9hS_sQu3fP1occXcbs2WO9qiHSVx6M,349449
+RobotLog2RQM/CRQM.py,sha256=NxFbIKvTOepkdNmv0V9aQCaU2jSGhuHO707XTglMF_A,69357
+RobotLog2RQM/RobotLog2RQM.pdf,sha256=--VWUBLqZOtfQXy9O8N28MvOT7VMRPg9fSAQXl8coK0,358016
 RobotLog2RQM/__init__.py,sha256=YKDTJjDsnQkr5X-gjjO8opwKUVKm6kc8sIUpURYMk48,596
 RobotLog2RQM/__main__.py,sha256=JabttEncy80antJWeGVmjoXyiF1DyXxkxdW4xLuHzT0,681
 RobotLog2RQM/logger.py,sha256=FnZZqssOcrF5yK6wxkgifScoQcFGrqrvzLvXWY3V-9A,4252
-RobotLog2RQM/robotlog2rqm.py,sha256=FeMJsBuAu1CLBjDJsQQs7CjQifYgqyhaPMNabnEeSc0,30160
-RobotLog2RQM/rqmtool.py,sha256=wDagUGptbPwRYyn5jo1RA8HJmwHoDX_iBew40WFtWJ0,7957
-RobotLog2RQM/version.py,sha256=4VudYtnU16wL-FZAKungXo19Q5QacjNSAHMEWv-53JE,916
+RobotLog2RQM/robotlog2rqm.py,sha256=zX8ibJqeQTPwtRF6zX-qHtT1d6jj1EI90vpaUL77FEM,30161
+RobotLog2RQM/rqmtool.py,sha256=s-rTI1MBby0SfQIBP-WRx5_frdtQBss86I9i04MBuy4,10564
+RobotLog2RQM/version.py,sha256=3E-s2UEJ2s5J5UVh1TPTW-T21mrSzBfY_KjCv-v7VQk,916
 RobotLog2RQM/RQM_templates/buildrecord.xml,sha256=uGot7pNOjPR8do0JsJi0Lz3OCU9NMhODRd428QgvHh4,1498
 RobotLog2RQM/RQM_templates/configuration.xml,sha256=NrFDv51fuGhgeMiZuRhQ5q_UJ0u_pWzdxisIF5AJs74,1378
 RobotLog2RQM/RQM_templates/executionresult.xml,sha256=WTp4qDk29peBc0ll6GHVXX_kF_YBsOVjy9vBzoz7_2k,2160
@@ -14,9 +14,9 @@ RobotLog2RQM/RQM_templates/suiteexecutionrecord.xml,sha256=9GAs2WqZMkFJSNEZULm9B
 RobotLog2RQM/RQM_templates/testcase.xml,sha256=zovFKj-37QHn2S8mMA_9RnAJ3zBmDJkJj31yelsnFFI,2167
 RobotLog2RQM/RQM_templates/testsuite.xml,sha256=r2ijEsyPoE7qzCtUxgIHDOEcqUveDN4SMf9HSE9b0ZU,1326
 RobotLog2RQM/RQM_templates/testsuitelog.xml,sha256=l-NlaCyk6Ben76PElXKOHfMlEvyQ-e9MOZ6-F9HvwDQ,1920
-robotframework_robotlog2rqm-1.5.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-robotframework_robotlog2rqm-1.5.0.dist-info/METADATA,sha256=mBHsyTik_HMPC-SsoTjqph_S_3MQc_CLj3VViXfgXuI,11846
-robotframework_robotlog2rqm-1.5.0.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-robotframework_robotlog2rqm-1.5.0.dist-info/entry_points.txt,sha256=94N661T4lHzLSey2WQ18OVduw9-Mf6Kh8HK7cBL2YPY,112
-robotframework_robotlog2rqm-1.5.0.dist-info/top_level.txt,sha256=jb_Gt6W44FoOLtGfBe7RzqCLaquhihkEWvSI1zjXDHc,13
-robotframework_robotlog2rqm-1.5.0.dist-info/RECORD,,
+robotframework_robotlog2rqm-1.6.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+robotframework_robotlog2rqm-1.6.0.dist-info/METADATA,sha256=k834p4eH88hGgfxhwifUu7ms7TXY83tJCty1uIS8WCA,12028
+robotframework_robotlog2rqm-1.6.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+robotframework_robotlog2rqm-1.6.0.dist-info/entry_points.txt,sha256=yLoNhxm2lfj3FxMx3Orct8db4qkPLII8u241GAH6BB0,111
+robotframework_robotlog2rqm-1.6.0.dist-info/top_level.txt,sha256=jb_Gt6W44FoOLtGfBe7RzqCLaquhihkEWvSI1zjXDHc,13
+robotframework_robotlog2rqm-1.6.0.dist-info/RECORD,,

{robotframework_robotlog2rqm-1.5.0.dist-info → robotframework_robotlog2rqm-1.6.0.dist-info}/WHEEL

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

{robotframework_robotlog2rqm-1.5.0.dist-info → robotframework_robotlog2rqm-1.6.0.dist-info}/entry_points.txt

@@ -1,4 +1,3 @@
 [console_scripts]
 RQMTool = RobotLog2RQM.rqmtool:RQMTool
 RobotLog2RQM = RobotLog2RQM.robotlog2rqm:RobotLog2RQM
-