Add an option to ignore param value in test case id

Author: ramir-dn

pytest_reportportal/config.py

@@ -44,6 +44,7 @@ class AgentConfig:
     rp_ignore_attributes: set
     rp_is_skipped_an_issue: bool
     rp_issue_id_marks: bool
+    rp_ignore_param_val: bool
     rp_bts_issue_url: str
     rp_bts_project: str
     rp_bts_url: str
@@ -82,6 +83,7 @@ def __init__(self, pytest_config: Config) -> None:
         self.rp_ignore_attributes = set(self.find_option(pytest_config, "rp_ignore_attributes") or [])
         self.rp_is_skipped_an_issue = self.find_option(pytest_config, "rp_is_skipped_an_issue")
         self.rp_issue_id_marks = self.find_option(pytest_config, "rp_issue_id_marks")
+        self.rp_ignore_param_val = self.find_option(pytest_config, "rp_ignore_param_val")
         self.rp_bts_issue_url = self.find_option(pytest_config, "rp_bts_issue_url")
         if not self.rp_bts_issue_url:
             self.rp_bts_issue_url = self.find_option(pytest_config, "rp_issue_system_url")

pytest_reportportal/plugin.py

@@ -634,6 +634,7 @@ def add_shared_option(name, help_str, default=None, action="store"):
         help="Path separator to display directories in test hierarchy",
     )
     parser.addini("rp_hierarchy_test_file", default=True, type="bool", help="Show file name in hierarchy")
+    parser.addini("rp_ignore_param_val", default=False, type="bool", help="Ignore parameter values in test id")
     parser.addini(
         "rp_issue_system_url",
         default="",

pytest_reportportal/service.py

@@ -599,6 +599,7 @@ def _get_code_ref(self, item: Item) -> str:
 
     def _get_test_case_id(self, mark, leaf: Dict[str, Any]) -> str:
         parameters: Optional[Dict[str, Any]] = leaf.get("parameters", None)
+        parameters_indices: Optional[Dict[str, Any]] = leaf.get("parameters_indices", None)
         parameterized = True
         selected_params: Optional[List[str]] = None
         if mark is not None:
@@ -611,6 +612,8 @@ def _get_test_case_id(self, mark, leaf: Dict[str, Any]) -> str:
         if parameterized and parameters is not None and len(parameters) > 0:
             if selected_params is not None and len(selected_params) > 0:
                 param_list = [str(parameters.get(param, None)) for param in selected_params]
+            elif self._config.rp_ignore_param_val:
+                param_list = [str(param) for param in parameters_indices.items()]
             else:
                 param_list = [str(param) for param in parameters.values()]
             param_str = "[{}]".format(",".join(sorted(param_list)))
@@ -729,6 +732,19 @@ def _get_parameters(self, item) -> Optional[Dict[str, Any]]:
             return None
         return {str(k): v.replace("\0", "\\0") if isinstance(v, str) else v for k, v in params.items()}
 
+    def _get_parameters_indices(self, item) -> Optional[Dict[str, Any]]:
+        """
+        Get params indices of item.
+
+        :param item: Pytest.Item
+        :return: dict of params indices
+        """
+        indices = item.callspec.indices if hasattr(item, "callspec") else None
+        if not indices:
+            return None
+
+        return indices
+
     def _process_test_case_id(self, leaf: Dict[str, Any]) -> str:
         """
         Process Test Case ID if set.
@@ -793,6 +809,7 @@ def _process_metadata_item_start(self, leaf: Dict[str, Any]) -> None:
         leaf["name"] = self._process_item_name(leaf)
         leaf["description"] = self._get_item_description(item)
         leaf["parameters"] = self._get_parameters(item)
+        leaf["parameters_indices"] = self._get_parameters_indices(item)
         leaf["code_ref"] = self._get_code_ref(item)
         leaf["test_case_id"] = self._process_test_case_id(leaf)
         leaf["issue"] = self._process_issue(item)

tests/unit/test_plugin.py

@@ -345,6 +345,7 @@ def test_pytest_addoption_adds_correct_ini_file_arguments():
         "rp_hierarchy_dirs",
         "rp_hierarchy_dir_path_separator",
         "rp_hierarchy_test_file",
+        "rp_ignore_param_val",
         "rp_issue_system_url",
         "rp_bts_issue_url",
         "rp_bts_project",