Merge pull request #383 from ramir-dn/restore_rp_display_suite_test_file

Restore rp_display_suite_test_file and fix bug with rp_dir_level

Author: HardNorth

pytest_reportportal/config.py

@@ -40,6 +40,7 @@ class AgentConfig:
     rp_hierarchy_code: bool
     rp_dir_level: int
     rp_hierarchy_dirs: bool
+    rp_display_suite_test_file: bool
     rp_dir_path_separator: str
     rp_ignore_attributes: set
     rp_is_skipped_an_issue: bool
@@ -80,6 +81,8 @@ def __init__(self, pytest_config: Config) -> None:
                                                  'rp_hierarchy_dirs_level'))
         self.rp_hierarchy_dirs = self.find_option(pytest_config,
                                                   'rp_hierarchy_dirs')
+        self.rp_display_suite_test_file = self.find_option(pytest_config,
+                                                           'rp_display_suite_test_file')
         self.rp_dir_path_separator = \
             self.find_option(pytest_config, 'rp_hierarchy_dir_path_separator')
         self.rp_ignore_attributes = set(self.find_option(pytest_config, 'rp_ignore_attributes') or [])

pytest_reportportal/plugin.py

@@ -501,6 +501,11 @@ def add_shared_option(name, help_str, default=None, action='store'):
         default=False,
         type='bool',
         help='Enables hierarchy for directories')
+    parser.addini(
+        'rp_display_suite_test_file',
+        default=True,
+        type='bool',
+        help='Show file name in hierarchy. Depends on rp_hierarchy_dirs_level to get deep enough')
     parser.addini(
         'rp_hierarchy_dir_path_separator',
         default=os.path.sep,

pytest_reportportal/service.py

@@ -100,6 +100,7 @@ class LeafType(Enum):
     """This class stores test item path types."""
 
     DIR = auto()
+    FILE = auto()
     CODE = auto()
     ROOT = auto()
 
@@ -272,28 +273,37 @@ def _build_test_tree(self, session: Session) -> Dict[str, Any]:
                 children_leafs = current_leaf['children']
 
                 leaf_type = LeafType.DIR
-                if i >= len(dir_path):
+                if i == len(dir_path):
+                    leaf_type = LeafType.FILE
+                if i > len(dir_path):
                     leaf_type = LeafType.CODE
 
                 if leaf not in children_leafs:
                     children_leafs[leaf] = self._get_leaf(leaf_type, current_leaf, leaf)
                 current_leaf = children_leafs[leaf]
         return test_tree
 
+    def _remove_node(self, test_tree: Dict[str, Any], max_dir_level, dir_level, recursive):
+        parent_leaf = test_tree['parent']
+        current_item = test_tree['item']
+        del parent_leaf['children'][current_item]
+        for item, child_leaf in test_tree['children'].items():
+            parent_leaf['children'][item] = child_leaf
+            child_leaf['parent'] = parent_leaf
+            if recursive:
+                self._remove_root_dirs(child_leaf, max_dir_level, dir_level + 1)
+
     def _remove_root_dirs(self, test_tree: Dict[str, Any], max_dir_level, dir_level=0) -> None:
         if test_tree['type'] == LeafType.ROOT:
-            for item, child_leaf in test_tree['children'].items():
+            for child_leaf in list(test_tree['children'].values()):
                 self._remove_root_dirs(child_leaf, max_dir_level, 1)
-                return
+            return
         if test_tree['type'] == LeafType.DIR and dir_level <= max_dir_level:
-            new_level = dir_level + 1
-            parent_leaf = test_tree['parent']
-            current_item = test_tree['item']
-            del parent_leaf['children'][current_item]
-            for item, child_leaf in test_tree['children'].items():
-                parent_leaf['children'][item] = child_leaf
-                child_leaf['parent'] = parent_leaf
-                self._remove_root_dirs(child_leaf, max_dir_level, new_level)
+            self._remove_node(test_tree, max_dir_level, dir_level, recursive=True)
+            return
+        if test_tree['type'] == LeafType.FILE and not self._config.rp_display_suite_test_file:
+            self._remove_node(test_tree, max_dir_level, dir_level, recursive=False)
+            return
 
     def _generate_names(self, test_tree: Dict[str, Any]) -> None:
         if test_tree['type'] == LeafType.ROOT:
@@ -302,7 +312,7 @@ def _generate_names(self, test_tree: Dict[str, Any]) -> None:
         if test_tree['type'] == LeafType.DIR:
             test_tree['name'] = test_tree['item'].basename
 
-        if test_tree['type'] == LeafType.CODE:
+        if test_tree['type'] in [LeafType.CODE, LeafType.FILE]:
             item = test_tree['item']
             if isinstance(item, Module):
                 test_tree['name'] = os.path.split(str(item.fspath))[1]
@@ -312,11 +322,11 @@ def _generate_names(self, test_tree: Dict[str, Any]) -> None:
         for item, child_leaf in test_tree['children'].items():
             self._generate_names(child_leaf)
 
-    def _merge_leaf_type(self, test_tree, leaf_type, separator):
+    def _merge_leaf_types(self, test_tree, leaf_types, separator):
         child_items = list(test_tree['children'].items())
-        if test_tree['type'] != leaf_type:
+        if test_tree['type'] not in leaf_types:
             for item, child_leaf in child_items:
-                self._merge_leaf_type(child_leaf, leaf_type, separator)
+                self._merge_leaf_types(child_leaf, leaf_types, separator)
         elif len(test_tree['children'].items()) > 0:
             parent_leaf = test_tree['parent']
             current_item = test_tree['item']
@@ -327,13 +337,13 @@ def _merge_leaf_type(self, test_tree, leaf_type, separator):
                 child_leaf['parent'] = parent_leaf
                 child_leaf['name'] = \
                     current_name + separator + child_leaf['name']
-                self._merge_leaf_type(child_leaf, leaf_type, separator)
+                self._merge_leaf_types(child_leaf, leaf_types, separator)
 
     def _merge_dirs(self, test_tree: Dict[str, Any]) -> None:
-        self._merge_leaf_type(test_tree, LeafType.DIR, self._config.rp_dir_path_separator)
+        self._merge_leaf_types(test_tree, [LeafType.DIR], self._config.rp_dir_path_separator)
 
     def _merge_code(self, test_tree: Dict[str, Any]) -> None:
-        self._merge_leaf_type(test_tree, LeafType.CODE, '::')
+        self._merge_leaf_types(test_tree, [LeafType.CODE, LeafType.FILE], '::')
 
     def _build_item_paths(self, leaf: Dict[str, Any], path: List[Dict[str, Any]]) -> None:
         if 'children' in leaf and len(leaf['children']) > 0:

tests/unit/test_plugin.py

@@ -353,6 +353,7 @@ def test_pytest_addoption_adds_correct_ini_file_arguments():
         'rp_hierarchy_code',
         'rp_hierarchy_dirs_level',
         'rp_hierarchy_dirs',
+        'rp_display_suite_test_file',
         'rp_hierarchy_dir_path_separator',
         'rp_issue_system_url',
         'rp_bts_issue_url',