Merge pull request #86 from Lakitna/__init__.robot-is-wrongly-considered-unused

Init  .robot is wrongly considered unused

Author: Lakitna

src/robotframework_find_unused/commands/files.py

@@ -46,7 +46,11 @@ def cli_files(options: FileOptions):
     if len(file_paths) == 0:
         return cli_hard_exit(options.verbose)
 
-    files = cli_step_parse_file_use(file_paths, verbose=options.verbose)
+    files = cli_step_parse_file_use(
+        file_paths,
+        Path(options.source_path),
+        verbose=options.verbose,
+    )
 
     if options.show_tree:
         _cli_print_grouped_file_trees(files, options)

src/robotframework_find_unused/commands/step/discover_files.py

@@ -31,6 +31,12 @@ def cli_discover_file_paths(input_path: str, *, verbose: int) -> list[Path]:
 
     file_paths = [path[0] for path in robocop_config.paths]
     sorted_file_paths = sorted(file_paths, key=lambda f: f)
+    sorted_file_paths = sorted(
+        sorted_file_paths,
+        key=lambda p: len(p.parts)
+        # __init__ files should always be before the files they apply to
+        + (-0.5 if p.stem == "__init__" else 0),
+    )
 
     _log_file_stats(sorted_file_paths, input_path, verbose)
     return sorted_file_paths

src/robotframework_find_unused/commands/step/parse_file_use.py

@@ -14,23 +14,23 @@
 from robotframework_find_unused.visitors.robot.file_import import RobotVisitorFileImports
 
 
-def cli_step_parse_file_use(file_paths: list[Path], *, verbose: int):
+def cli_step_parse_file_use(file_paths: list[Path], source_path: Path, *, verbose: int):
     """
     Parse files and keep the user up-to-date on progress
     """
     click.echo("Parsing file imports...")
 
-    files = _count_file_uses(file_paths)
+    files = _count_file_uses(file_paths, source_path)
 
     _log_file_stats(files, verbose)
     return files
 
 
-def _count_file_uses(file_paths: list[Path]) -> list[FileUseData]:
+def _count_file_uses(file_paths: list[Path], source_path: Path) -> list[FileUseData]:
     """
     Walk through all robot files to keep track of imports.
     """
-    visitor = RobotVisitorFileImports()
+    visitor = RobotVisitorFileImports(source_path)
     visit_robot_files(
         file_paths,
         visitor,

src/robotframework_find_unused/common/cli.py

@@ -21,7 +21,7 @@ def pretty_kw_name(keyword: KeywordData) -> str:
     return name
 
 
-def pretty_file_path(path: str, file_types: set[FileUseType]) -> str:
+def pretty_file_path(path: str, file_types: set[FileUseType]) -> str:  # noqa: PLR0911
     """
     Format file path for output to the user
     """
@@ -36,6 +36,8 @@ def pretty_file_path(path: str, file_types: set[FileUseType]) -> str:
         return click.style(path, fg="bright_cyan")
     if file_type == "SUITE":
         return path
+    if file_type == "SUITE_INIT":
+        return path
     if file_type == "LIBRARY":
         return click.style(path, fg="bright_magenta")
     if file_type == "VARIABLE":

src/robotframework_find_unused/common/const.py

@@ -83,6 +83,7 @@ class LibraryData:
 
 FileUseType: TypeAlias = Literal[
     "SUITE",
+    "SUITE_INIT",
     "RESOURCE",
     "LIBRARY",
     "VARIABLE",

src/robotframework_find_unused/visitors/robot/file_import.py

@@ -23,12 +23,16 @@ class RobotVisitorFileImports(ModelVisitor):
     Gather file imports
     """
 
+    root_directory: Path
     files: dict[str, FileUseData]
+    init_files: dict[Path, FileUseData]
     current_working_file: FileUseData | None = None
     current_working_directory: Path | None = None
 
-    def __init__(self) -> None:
+    def __init__(self, root_directory: Path) -> None:
+        self.root_directory = root_directory.absolute()
         self.files = {}
+        self.init_files = {}
         super().__init__()
 
     def visit_File(self, node: File):  # noqa: N802
@@ -48,21 +52,63 @@ def visit_File(self, node: File):  # noqa: N802
             # Already found as import
             self.current_working_file = self.files[current_file_path_normalized]
         else:
-            self.current_working_file = FileUseData(
-                normalize_file_path(current_working_file),
-                path_absolute=current_working_file,
-                type={file_type},
-                used_by=[],
+            self.current_working_file = self._register_file(
+                current_file_path_normalized,
+                file_type,
+                current_working_file,
             )
-            self.files[current_file_path_normalized] = self.current_working_file
 
         return self.generic_visit(node)
 
+    def _register_file(
+        self,
+        current_file_path_normalized: str,
+        file_type: Literal["SUITE", "SUITE_INIT", "RESOURCE"],
+        current_working_file: Path,
+    ) -> FileUseData:
+        """Register a file"""
+        file = FileUseData(
+            id=current_file_path_normalized,
+            path_absolute=current_working_file,
+            type={file_type},
+            used_by=[],
+        )
+
+        if file_type == "SUITE_INIT":
+            self.init_files[current_working_file.parent] = file
+
+            # Assumption: Due to file path sorting, `__init__` is always processed before any suite
+            # file it applies to.
+
+        if file_type == "SUITE":
+            self._register_use_of_suite_init(file)
+
+        self.files[current_file_path_normalized] = file
+        return file
+
+    def _register_use_of_suite_init(self, file: FileUseData) -> None:
+        """Register use of suite __init__ files"""
+        if len(self.init_files) == 0:
+            return
+
+        root_dir_parts_len = len(self.root_directory.parts)
+
+        path = file.path_absolute
+        while len(path.parts) > root_dir_parts_len:
+            path = path.parent
+            init_file = self.init_files.get(path, None)
+
+            if init_file:
+                init_file.used_by.append(file)
+
     def _get_file_type(
         self,
         file_node: File,
         file_path: Path,
-    ) -> Literal["SUITE", "RESOURCE"] | None:
+    ) -> Literal["SUITE", "SUITE_INIT", "RESOURCE"] | None:
+        if file_path.stem == "__init__":
+            return "SUITE_INIT"
+
         file_extension = file_path.suffix.lstrip(".").lower()
 
         if file_extension == "robot":

test/atest/files/basic/expected_output.log

@@ -1,6 +1,6 @@
 Discovering files in `./robot` using Robocop config...
 Parsing file imports...
-[ DONE ] Parsed 4 files
+[ DONE ] Parsed 5 files
 
 Found 1 unused files:
   ./gamma.resource

test/atest/files/basic/expected_output_count.log

@@ -1,8 +1,9 @@
 Discovering files in `./robot` using Robocop config...
 Parsing file imports...
-[ DONE ] Parsed 4 files
+[ DONE ] Parsed 5 files
 
 import_count	file
 0	./gamma.resource
+1	./__init__.robot
 1	./alpha.resource
 2	./beta.resource

test/atest/files/basic/expected_output_tree.log

@@ -1,14 +1,15 @@
 Discovering files in `./robot` using Robocop config...
 Parsing file imports...
-[ DONE ] Parsed 4 files
+[ DONE ] Parsed 5 files
 Building 1 file import trees...
 Printing 1 tree groups...
 
 [[REPOSITORY_ROOT]]/test/atest/files/basic/robot/test.robot
+│  ./__init__.robot
 │  ./alpha.resource
 │  │  ./beta.resource
 │  ./beta.resource [Already imported]
-Tree height: 4 | Tree depth: 2 | Unique files: 3 | Circular imports: 0 | Already imported: 1
+Tree height: 5 | Tree depth: 2 | Unique files: 4 | Circular imports: 0 | Already imported: 1
 
 Found 1 unused files:
   ./gamma.resource