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

{robotframework_robotlog2rqm-1.5.0/robotframework_robotlog2rqm.egg-info → robotframework_robotlog2rqm-1.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 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

{robotframework_robotlog2rqm-1.5.0 → 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,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
 

{robotframework_robotlog2rqm-1.5.0 → robotframework_robotlog2rqm-1.6.0}/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")

{robotframework_robotlog2rqm-1.5.0 → robotframework_robotlog2rqm-1.6.0}/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:

{robotframework_robotlog2rqm-1.5.0 → robotframework_robotlog2rqm-1.6.0}/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 → robotframework_robotlog2rqm-1.6.0/robotframework_robotlog2rqm.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 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