Pytest BDD implementation: Rule keyword: WIP

Author: HardNorth

examples/bdd/step_defs/test_rule_steps.py

@@ -0,0 +1,43 @@
+#  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.
+
+"""Rule keyword test module."""
+from pytest_bdd import given, scenarios, then
+
+
+scenarios("../features/rule_keyword.feature")
+
+
+@given("I have empty step")
+def empty_step():
+    """Empty step implementation."""
+    pass
+
+
+@then("I have another empty step")
+def another_empty_step():
+    """Another empty step implementation."""
+    pass
+
+
+@then("I have one more empty step")
+def one_more_empty_step():
+    """One more empty step implementation."""
+    pass
+
+
+@then("I have one more else empty step")
+def one_more_else_empty_step():
+    """One more else empty step implementation."""
+    pass

pytest_reportportal/service.py

@@ -67,6 +67,12 @@
     make_python_name: Callable[[str], str] = lambda x: x
     PYTEST_BDD = False
 
+try:
+    # noinspection PyPackageRequirements
+    from pytest_bdd.parser import Rule
+except ImportError:
+    Rule = type("dummy", (), {})  # Old pytest-bdd versions do not have Rule
+
 from reportportal_client import RP, create_client
 from reportportal_client.helpers import dict_to_payload, gen_attributes, get_launch_sys_attrs, get_package_version
 
@@ -366,9 +372,18 @@ def _generate_names(self, test_tree: Dict[str, Any]) -> None:
             elif isinstance(item, Scenario):
                 keyword = getattr(item, "keyword", "Scenario")
                 test_tree["name"] = f"{keyword}: {item.name}"
+            elif isinstance(item, Rule):
+                keyword = getattr(item, "keyword", "Rule")
+                test_tree["name"] = f"{keyword}: {item.name}"
             else:
                 test_tree["name"] = item.name
 
+        if test_tree["type"] == LeafType.SUITE:
+            item = test_tree["item"]
+            if isinstance(item, Rule):
+                keyword = getattr(item, "keyword", "Rule")
+                test_tree["name"] = f"{keyword}: {item.name}"
+
         for item, child_leaf in test_tree["children"].items():
             self._generate_names(child_leaf)
 
@@ -395,7 +410,7 @@ def _merge_dirs(self, test_tree: Dict[str, Any]) -> None:
         self._merge_leaf_types(test_tree, {LeafType.DIR, LeafType.FILE}, self._config.rp_dir_path_separator)
 
     def _merge_code_with_separator(self, test_tree: Dict[str, Any], separator: str) -> None:
-        self._merge_leaf_types(test_tree, {LeafType.CODE, LeafType.FILE, LeafType.DIR}, separator)
+        self._merge_leaf_types(test_tree, {LeafType.CODE, LeafType.FILE, LeafType.DIR, LeafType.SUITE}, separator)
 
     def _merge_code(self, test_tree: Dict[str, Any]) -> None:
         self._merge_code_with_separator(test_tree, "::")
@@ -454,7 +469,7 @@ def _get_item_description(self, test_item: Any) -> Optional[str]:
                     return trim_docstring(doc)
         if isinstance(test_item, DoctestItem):
             return test_item.reportinfo()[2]
-        if isinstance(test_item, (Feature, Scenario, ScenarioTemplate)):
+        if isinstance(test_item, (Feature, Scenario, ScenarioTemplate, Rule)):
             description = test_item.description
             if description:
                 return description
@@ -472,7 +487,7 @@ def _lock(self, leaf: Dict[str, Any], func: Callable[[Dict[str, Any]], Any]) ->
                 return func(leaf)
         return func(leaf)
 
-    def _process_bdd_attributes(self, scenario: Union[Feature, Scenario]) -> List[Dict[str, str]]:
+    def _process_bdd_attributes(self, scenario: Union[Feature, Scenario, Rule]) -> List[Dict[str, str]]:
         attributes = []
         for tag in scenario.tags:
             key = None
@@ -485,7 +500,7 @@ def _process_bdd_attributes(self, scenario: Union[Feature, Scenario]) -> List[Di
             attributes.append(attribute)
         return attributes
 
-    def _build_start_suite_rq(self, leaf: Dict[str, Any]) -> Dict[str, Any]:
+    def _get_suite_code_ref(self, leaf: Dict[str, Any]) -> str:
         item = leaf["item"]
         if leaf["type"] == LeafType.DIR:
             code_ref = str(item)
@@ -494,9 +509,16 @@ def _build_start_suite_rq(self, leaf: Dict[str, Any]) -> Dict[str, Any]:
                 code_ref = str(item.rel_filename)
             else:
                 code_ref = str(item.fspath)
+        elif leaf["type"] == LeafType.SUITE:
+            code_ref = self._get_suite_code_ref(leaf["parent"]) + f"/[{type(item).__name__}:{item.name}]"
         else:
             code_ref = str(item.fspath)
+        return code_ref
+
+    def _build_start_suite_rq(self, leaf: Dict[str, Any]) -> Dict[str, Any]:
+        code_ref = self._get_suite_code_ref(leaf)
         parent_item_id = self._lock(leaf["parent"], lambda p: p.get("item_id")) if "parent" in leaf else None
+        item = leaf["item"]
         payload = {
             "name": self._truncate_item_name(leaf["name"]),
             "description": self._get_item_description(item),
@@ -505,7 +527,7 @@ def _build_start_suite_rq(self, leaf: Dict[str, Any]) -> Dict[str, Any]:
             "code_ref": code_ref,
             "parent_item_id": parent_item_id,
         }
-        if isinstance(item, Feature):
+        if isinstance(item, (Feature, Scenario, Rule)):
             payload["attributes"] = self._process_bdd_attributes(item)
         return payload
 
@@ -1057,12 +1079,14 @@ def start_bdd_scenario(self, feature: Feature, scenario: Scenario) -> None:
         else:
             feature_leaf = self._create_leaf(LeafType.FILE, root_leaf, feature)
             children_leafs[feature] = feature_leaf
+        children_leafs = feature_leaf["children"]
         rule = getattr(scenario, "rule", None)
         if rule:
             if rule in children_leafs:
                 rule_leaf = children_leafs[rule]
             else:
                 rule_leaf = self._create_leaf(LeafType.SUITE, feature_leaf, rule)
+                children_leafs[rule] = rule_leaf
         else:
             rule_leaf = feature_leaf
         children_leafs = rule_leaf["children"]
@@ -1074,6 +1098,7 @@ def start_bdd_scenario(self, feature: Feature, scenario: Scenario) -> None:
             if background not in children_leafs:
                 background_leaf = self._create_leaf(LeafType.NESTED, rule_leaf, background)
                 children_leafs[background] = background_leaf
+
         self._remove_file_names(root_leaf)
         self._generate_names(root_leaf)
         if not self._config.rp_hierarchy_code:

tests/integration/test_bdd.py

@@ -390,3 +390,11 @@ def test_bdd_background_two_steps(mock_client_init):
     assert scenario_step_call[0][2] == "step"
     assert scenario_step_call[1]["parent_item_id"] == scenario_call[1]["name"] + "_1"
     assert scenario_step_call[1]["has_stats"] is False
+
+
+@mock.patch(REPORT_PORTAL_SERVICE)
+def test_bdd_rule(mock_client_init):
+    mock_client = setup_mock(mock_client_init)
+    setup_mock_for_logging(mock_client_init)
+    result = utils.run_pytest_tests(tests=["examples/bdd/step_defs/test_rule_steps.py"])
+    assert int(result) == 0, "Exit code should be 0 (no errors)"