Add 'remove_keywords' configuration variable

Author: HardNorth

CHANGELOG.md

@@ -7,6 +7,8 @@
 - Keywords names now contain Keyword types, by @HardNorth
 ### Added
 - Support for `Python 3.13`, by @HardNorth
+- `RP_REMOVE_KEYWORDS` configuration variable, by @HardNorth
+- `--remove-keywords` argument support, by @HardNorth
 ### Removed
 - `Python 3.7` support, by @HardNorth
 

README.md

@@ -93,6 +93,8 @@ NOT REQUIRED:
 --variable RP_VERIFY_SSL:"True"
     - Default value is "True", disables SSL verification for HTTP requests.
       Also, you can specify a full path to your certificate as the value.
+--variable RP_REMOVE_KEYWORDS:"True"
+    - Default value is "False", remove  keywords from reporting, passed with '--remove-keywords' Robot's argument.
 ```
 
 ### Logging

robotframework_reportportal/listener.py

@@ -131,7 +131,7 @@ class listener:
     _variables: Optional[Variables]
     _keyword_filters: List[_KeywordMatch] = []
     _remove_all_keyword_content: bool = False
-    _remove_passed_keywords: bool = False
+    _remove_data_passed_tests: bool = False
     ROBOT_LISTENER_API_VERSION = 2
 
     def __init__(self) -> None:
@@ -324,6 +324,9 @@ def variables(self) -> Variables:
         return self._variables
 
     def _process_keyword_skip(self):
+        if not self.variables.remove_keywords:
+            return
+
         try:
             self._keyword_filters = []
 
@@ -339,7 +342,7 @@ def _process_keyword_skip(self):
                         self._remove_all_keyword_content = True
                         break
                     if "PASSED" == pattern_str_upper:
-                        self._remove_passed_keywords = True
+                        self._remove_data_passed_tests = True
                         break
                     if pattern_str_upper in {"NOT_RUN", "NOTRUN", "NOT RUN"}:
                         self._keyword_filters.append(_KeywordStatusEqual("NOT RUN"))
@@ -360,7 +363,7 @@ def _process_keyword_skip(self):
                         elif "TAG" == pattern_type.upper():
                             self._keyword_filters.append(_KeywordTagMatch(pattern.strip()))
         except ImportError:
-            warn('Unable to locate Robot Framework context. "removekeywords" feature will not work.', stacklevel=2)
+            warn('Unable to locate Robot Framework context. "--remove-keywords" feature will not work.', stacklevel=2)
 
     def start_launch(self, attributes: Dict[str, Any], ts: Optional[Any] = None) -> None:
         """Start a new launch at the ReportPortal.
@@ -468,9 +471,9 @@ def end_test(self, _: Optional[str], attributes: Dict, ts: Optional[Any] = None)
         test = self.current_item.update(attributes)
         if not test.critical and test.status == "FAIL":
             test.status = "SKIP"
-        if attributes["status"] == "FAIL" and self._remove_passed_keywords:
+        if attributes["status"] == "FAIL" and self._remove_data_passed_tests:
             self._post_skipped_keywords(test)
-        elif self._remove_passed_keywords:
+        elif self._remove_data_passed_tests:
             for kwd in test.skipped_keywords:
                 self._log_keyword_content_removed(kwd.rp_item_id, kwd.start_time)
         logger.debug(f"ReportPortal - End Test: {test.robot_attributes}")
@@ -497,7 +500,7 @@ def start_keyword(self, name: str, attributes: Dict, ts: Optional[Any] = None) -
         parent = self.current_item
         kwd.rp_parent_item_id = parent.rp_item_id
         skip_kwd = parent.remove_data
-        skip_data = self._remove_all_keyword_content or self._remove_passed_keywords
+        skip_data = self._remove_all_keyword_content or self._remove_data_passed_tests
         kwd.remove_data = skip_kwd or skip_data
 
         if kwd.remove_data:
@@ -519,7 +522,7 @@ def start_keyword(self, name: str, attributes: Dict, ts: Optional[Any] = None) -
             self._do_start_keyword(kwd, ts)
             if skip_data:
                 kwd.skip_origin = kwd
-            if self._remove_passed_keywords:
+            if self._remove_data_passed_tests:
                 parent.skipped_keywords.append(kwd)
 
         self._add_current_item(kwd)
@@ -571,7 +574,7 @@ def end_keyword(self, _: Optional[str], attributes: Dict, ts: Optional[Any] = No
         elif kwd.posted and kwd.remove_data and kwd.skip_origin is kwd:
             if self._remove_all_keyword_content:
                 self._log_keyword_content_removed(kwd.rp_item_id, kwd.start_time)
-            elif not self._remove_passed_keywords:
+            elif not self._remove_data_passed_tests:
                 self._log_keyword_data_removed(kwd.rp_item_id, kwd.start_time)
 
         self._remove_current_item()

robotframework_reportportal/variables.py

@@ -67,6 +67,7 @@ class Variables:
     launch_uuid_print_output: Optional[OutputType]
     client_type: ClientType
     http_timeout: Optional[Union[Tuple[float, float], float]]
+    remove_keywords: bool
 
     def __init__(self) -> None:
         """Initialize instance attributes."""
@@ -110,6 +111,8 @@ def __init__(self) -> None:
         else:
             self.http_timeout = connect_timeout or read_timeout
 
+        self.remove_keywords = to_bool(get_variable("RP_REMOVE_KEYWORDS", default="False"))
+
         self.api_key = get_variable("RP_API_KEY")
         if not self.api_key:
             token = get_variable("RP_UUID")

tests/integration/test_remove_keywords.py

@@ -18,6 +18,30 @@
 
 from tests import REPORT_PORTAL_SERVICE
 from tests.helpers import utils
+from tests.helpers.utils import DEFAULT_VARIABLES
+
+
+@mock.patch(REPORT_PORTAL_SERVICE)
+def test_remove_keyword_not_provided(mock_client_init):
+    mock_client = mock_client_init.return_value
+    mock_client.start_test_item.side_effect = utils.item_id_gen
+
+    result = utils.run_robot_tests(
+        ["examples/for_keyword.robot"], variables=DEFAULT_VARIABLES, arguments={"--remove-keywords": "FOR"}
+    )
+    assert result == 0
+
+    launch_start = mock_client.start_launch.call_args_list
+    launch_finish = mock_client.finish_launch.call_args_list
+    assert len(launch_start) == len(launch_finish) == 1
+
+    item_start_calls = mock_client.start_test_item.call_args_list
+    item_finish_calls = mock_client.finish_test_item.call_args_list
+    assert len(item_start_calls) == len(item_finish_calls)
+    assert len(item_finish_calls) == 9
+
+    statuses = [finish[1]["status"] for finish in item_finish_calls]
+    assert statuses == ["PASSED"] * 9
 
 
 @pytest.mark.parametrize(
@@ -218,7 +242,9 @@ def test_for_and_while_keyword_remove(
     mock_client = mock_client_init.return_value
     mock_client.start_test_item.side_effect = utils.item_id_gen
 
-    result = utils.run_robot_tests([file], arguments={"--remove-keywords": keyword_to_remove})
+    variables = DEFAULT_VARIABLES.copy()
+    variables["RP_REMOVE_KEYWORDS"] = True
+    result = utils.run_robot_tests([file], variables=variables, arguments={"--remove-keywords": keyword_to_remove})
     assert result == exit_code
 
     launch_start = mock_client.start_launch.call_args_list