Add too long BDD Step name truncation on reporting

Author: HardNorth

CHANGELOG.md

@@ -1,6 +1,8 @@
 # Changelog
 
 ## [Unreleased]
+### Added
+- Too long BDD Step name truncation on reporting, by @HardNorth
 
 ## [5.5.0]
 ### Added

examples/bdd/features/long_step_scenario.feature

@@ -0,0 +1,4 @@
+Feature: Test long step scenario
+
+  Scenario: The scenario
+    Given A very long step. Seriously, this step is ridiculously long. Our users require such a long step and here it is. This is not even a half of the step, it will last really long. I believe you will get tired before you reach the end of the step. Why? Because our users send here a megabyte-length JSONs or things like that, despite our words that this is not good for user experience, since it's hard to read such a long lines on UI and for backend performance, since we use this field in full-text search. OK I'm out of thought what else I can write here, but the step must go on. Probably you will see some random typing soon to get the step longer than it's right now. Because only now we crossed a half of the length we need. Alright, here we go: 39248cht42 3x,r093mhxr0,3hr c089r3423 xk309,,r3 k302uk032 3249xul398u3 at 34r9k39489 aumvi xkr293jed0 i 93u9f32u smhf 09ktc903 a tu09r328 ef5u0fu3v 0k8utf2 u59du9v u423kuc 9f5kv 39kd3uf39 -3940u5kfu5 b3-90485l-k3f. Are you tired? I'm too, but we still need a few words at the end.

examples/bdd/step_defs/long_step_scenario_steps.py

@@ -0,0 +1,30 @@
+#  Copyright 2025 EPAM Systems
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      https://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  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.
+
+import logging
+
+from pytest_bdd import given, scenarios
+
+# Import the scenario from the feature file
+scenarios("../features/long_step_scenario.feature")
+
+
+LOGGER = logging.getLogger(__name__)
+
+
+@given(
+    "A very long step. Seriously, this step is ridiculously long. Our users require such a long step and here it is. This is not even a half of the step, it will last really long. I believe you will get tired before you reach the end of the step. Why? Because our users send here a megabyte-length JSONs or things like that, despite our words that this is not good for user experience, since it's hard to read such a long lines on UI and for backend performance, since we use this field in full-text search. OK I'm out of thought what else I can write here, but the step must go on. Probably you will see some random typing soon to get the step longer than it's right now. Because only now we crossed a half of the length we need. Alright, here we go: 39248cht42 3x,r093mhxr0,3hr c089r3423 xk309,,r3 k302uk032 3249xul398u3 at 34r9k39489 aumvi xkr293jed0 i 93u9f32u smhf 09ktc903 a tu09r328 ef5u0fu3v 0k8utf2 u59du9v u423kuc 9f5kv 39kd3uf39 -3940u5kfu5 b3-90485l-k3f. Are you tired? I'm too, but we still need a few words at the end."  # noqa: E501
+)
+def step_with_long_text():
+    LOGGER.info("Step with extremely long text executed successfully")

pytest_reportportal/service.py

@@ -1279,7 +1279,7 @@ def start_bdd_step(self, feature: Feature, scenario: Scenario, step: Step) -> No
             if feature.background:
                 background_leaf = scenario_leaf["children"][feature.background]
                 self._finish_bdd_step(background_leaf, "PASSED")
-        item_id = reporter.start_nested_step(f"{step.keyword} {step.name}", timestamp())
+        item_id = reporter.start_nested_step(self._truncate_item_name(f"{step.keyword} {step.name}"), timestamp())
         step_leaf["item_id"] = item_id
         step_leaf["exec"] = ExecStatus.IN_PROGRESS
 

tests/integration/test_bdd.py

@@ -1130,3 +1130,33 @@ def test_rp_tests_attributes_bdd_tags(mock_client_init):
     assert {"key": "test_key", "value": "test_value"} in attributes
     assert {"value": "ok"} in attributes
     assert {"key": "key", "value": "value"} in attributes
+
+
+@mock.patch(REPORT_PORTAL_SERVICE)
+def test_long_step(mock_client_init):
+    mock_client = setup_mock_for_logging(mock_client_init)
+    result = utils.run_pytest_tests(tests=["examples/bdd/step_defs/long_step_scenario_steps.py"])
+    assert int(result) == 0, "Exit code should be 0 (no errors)"
+
+    # Verify scenario is correctly identified
+    scenario_call = mock_client.start_test_item.call_args_list[0]
+    assert scenario_call[1]["name"] == "Feature: Test long step scenario - Scenario: The scenario"
+    assert scenario_call[1]["item_type"] == "STEP"
+    assert scenario_call[1]["code_ref"] == "features/long_step_scenario.feature/[SCENARIO:The scenario]"
+
+    # Verify step is truncated but still identifiable
+    step_call = mock_client.start_test_item.call_args_list[1]
+    step_name = step_call[0][0]
+    assert step_name.startswith("Given A very long step.")
+    assert len(step_name) <= 1024, "Step name should be truncated to at most 1024 characters"
+    assert step_name.endswith("..."), "Truncated step should have ellipsis"
+
+    # Verify step details
+    assert step_call[0][2] == "step"
+    assert step_call[1]["parent_item_id"] == scenario_call[1]["name"] + "_1"
+    assert step_call[1]["has_stats"] is False
+
+    # Verify all steps pass
+    finish_calls = mock_client.finish_test_item.call_args_list
+    for call in finish_calls:
+        assert call[1]["status"] == "PASSED"