Add custom Test Case ID

Author: HardNorth

examples/bdd/features/custom_test_case_id.feature

@@ -0,0 +1,5 @@
+Feature: Test dummy scenario
+
+  @tc_id:my_tc_id
+  Scenario: The scenario
+    Given I have empty step

examples/bdd/features/scenario_outline_test_case_id.feature

@@ -0,0 +1,11 @@
+Feature: Basic test with parameters
+
+  @tc_id:outline_tc_id
+  Scenario Outline: Test with different parameters
+    Given It is test with parameters
+    When I have parameter <str>
+    Then I emit number <parameters> on level info
+
+    Examples:
+      | str      | parameters |
+      | "first"  | 123        |

examples/bdd/step_defs/custom_test_case_id_steps.py

@@ -0,0 +1,27 @@
+#  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/custom_test_case_id.feature")
+
+LOGGER = logging.getLogger(__name__)
+
+
+@given("I have empty step")
+def step_with_custom_test_case_id():
+    LOGGER.info("I have empty step")

examples/bdd/step_defs/scenario_outline_test_case_id_steps.py

@@ -0,0 +1,37 @@
+#  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, parsers, scenarios, then, when
+
+# Import the scenario from the feature file
+scenarios("../features/scenario_outline_test_case_id.feature")
+
+LOGGER = logging.getLogger(__name__)
+
+
+@given("It is test with parameters")
+def step_with_parameters():
+    LOGGER.info("It is test with parameters")
+
+
+@when(parsers.parse('I have parameter "{parameter}"'))
+def have_parameter_str(parameter: str):
+    LOGGER.info("String parameter %s", parameter)
+
+
+@then(parsers.parse("I emit number {parameters:d} on level info"))
+def emit_number_info(parameters):
+    LOGGER.info("Test with parameters: %d", parameters)

pytest_reportportal/service.py

@@ -1189,6 +1189,16 @@ def _get_scenario_code_ref(self, scenario: Scenario, scenario_template: Optional
         return code_ref
 
     def _get_scenario_test_case_id(self, leaf: Dict[str, Any]) -> str:
+        attributes = leaf.get("attributes", [])
+        params: Optional[Dict[str, str]] = leaf.get("parameters", None)
+        for attribute in attributes:
+            if attribute.get("key", None) == "tc_id":
+                tc_id = attribute["value"]
+                params_str = ""
+                if params:
+                    params_str = ";".join([f"{k}:{v}" for k, v in sorted(params.items())])
+                    params_str = f"[{params_str}]"
+                return f"{tc_id}{params_str}"
         return leaf["code_ref"]
 
     def _process_scenario_metadata(self, leaf: Dict[str, Any]) -> None:
@@ -1203,7 +1213,7 @@ def _process_scenario_metadata(self, leaf: Dict[str, Any]) -> None:
         ).rstrip("\n")
         leaf["description"] = description if description else None
         scenario_template = self._get_scenario_template(scenario)
-        if scenario_template:
+        if scenario_template and scenario_template.templated:
             parameters = self._get_scenario_parameters_from_template(scenario)
             leaf["parameters"] = parameters
             if parameters:
@@ -1213,8 +1223,8 @@ def _process_scenario_metadata(self, leaf: Dict[str, Any]) -> None:
                 else:
                     leaf["description"] = parameters_str
         leaf["code_ref"] = self._get_scenario_code_ref(scenario, scenario_template)
-        leaf["test_case_id"] = self._get_scenario_test_case_id(leaf)
         leaf["attributes"] = self._process_bdd_attributes(scenario)
+        leaf["test_case_id"] = self._get_scenario_test_case_id(leaf)
 
     def _finish_bdd_step(self, leaf: Dict[str, Any], status: str) -> None:
         if leaf["exec"] != ExecStatus.IN_PROGRESS:

tests/integration/test_bdd.py

@@ -1037,3 +1037,60 @@ def test_data_table_parameter_steps(mock_client_init):
     finish_calls = mock_client.finish_test_item.call_args_list
     for call in finish_calls:
         assert call[1]["status"] == "PASSED"
+
+
+@mock.patch(REPORT_PORTAL_SERVICE)
+def test_scenario_outline_test_case_id(mock_client_init):
+    mock_client = setup_mock_for_logging(mock_client_init)
+    result = utils.run_pytest_tests(tests=["examples/bdd/step_defs/scenario_outline_test_case_id_steps.py"])
+    assert int(result) == 0, "Exit code should be 0 (no errors)"
+
+    # Verify first scenario with parameters includes the test case ID
+    scenario_call = mock_client.start_test_item.call_args_list[0]
+    assert (
+        scenario_call[1]["name"]
+        == "Feature: Basic test with parameters - Scenario Outline: Test with different parameters"
+    )
+    assert scenario_call[1]["item_type"] == "STEP"
+    assert (
+        scenario_call[1]["code_ref"]
+        == "features/scenario_outline_test_case_id.feature/[EXAMPLE:Test with different parameters"
+        '[parameters:123;str:"first"]]'
+    )
+    assert scenario_call[1]["parameters"] == {"str": '"first"', "parameters": "123"}
+
+    # Verify the test case ID is correctly reported using the tag instead of code_ref
+    assert scenario_call[1]["test_case_id"] == 'outline_tc_id[parameters:123;str:"first"]'
+
+    # Verify all steps pass
+    finish_calls = mock_client.finish_test_item.call_args_list
+    for call in finish_calls:
+        assert call[1]["status"] == "PASSED"
+
+
+@mock.patch(REPORT_PORTAL_SERVICE)
+def test_custom_test_case_id(mock_client_init):
+    mock_client = setup_mock_for_logging(mock_client_init)
+    result = utils.run_pytest_tests(tests=["examples/bdd/step_defs/custom_test_case_id_steps.py"])
+    assert int(result) == 0, "Exit code should be 0 (no errors)"
+
+    # Verify scenario includes the test case ID
+    scenario_call = mock_client.start_test_item.call_args_list[0]
+    assert scenario_call[1]["name"] == "Feature: Test dummy scenario - Scenario: The scenario"
+    assert scenario_call[1]["item_type"] == "STEP"
+    assert scenario_call[1]["code_ref"] == "features/custom_test_case_id.feature/[SCENARIO:The scenario]"
+
+    # Verify the test case ID is correctly reported using the tag instead of code_ref
+    assert scenario_call[1]["test_case_id"] == "my_tc_id"
+
+    # Verify step info
+    step_call = mock_client.start_test_item.call_args_list[1]
+    assert step_call[0][0] == "Given I have empty step"
+    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"