Coverage for src/renaissance/project/project_scanner.py: 100%
57 statements
« prev ^ index » next coverage.py v7.17.0, created at 2026-11-16 16:04 +0000
« prev ^ index » next coverage.py v7.17.0, created at 2026-11-16 16:04 +0000
1# Copyright (C) 2024-2026 TNO
2#
3# Licensed under the terms specified in the LICENSE file in the root directory
4# of this repository, also available at:
5# https://github.com/TNO/Renaissance.Py/blob/main/LICENSE
7"""Language-specific source file scanners used to feed recipes with the files to process."""
9import json
10import subprocess
11from pathlib import Path
14class ProjectScanner:
15 """Base class for language-specific source file scanners."""
17 def find_sources(self) -> list[str]:
18 """Return the paths of source files found by this scanner. Implemented by subclasses."""
19 raise NotImplementedError
22class CppScanner(ProjectScanner):
23 """Scan a C/C++ project's compile_commands.json for source files."""
25 def __init__(self, compile_commands_path: str = "compile_commands.json") -> None:
26 """Store the path to the compile_commands.json to read sources from."""
27 self.compile_commands_path = compile_commands_path
29 def find_sources(self) -> list[str]:
30 """Return every file entry listed in compile_commands.json, sorted and deduplicated."""
31 if not Path(self.compile_commands_path).exists():
32 message = "compile_commands.json not found"
33 raise FileNotFoundError(message)
34 with Path(self.compile_commands_path).open() as f:
35 commands = json.load(f)
36 return sorted({entry["file"] for entry in commands if "file" in entry})
39class JavaScanner(ProjectScanner):
40 """Scan a directory tree for Java source files."""
42 def __init__(self, root_dir: str = ".") -> None:
43 """Store the root directory to scan for .java files."""
44 self.root_dir = root_dir
46 def find_sources(self) -> list[str]:
47 """Return every .java file under root_dir, sorted."""
48 # TODO: is this correct? does this filter out files correctly?
49 # See https://github.com/TNO/Renaissance.Py/issues/200
51 java_files = Path(self.root_dir).rglob("*.java")
52 return sorted(str(f) for f in java_files)
55class PythonScanner(ProjectScanner):
56 """Scan a directory tree for Python source files, skipping hidden files and directories."""
58 SPECIAL_EXCLUDED_DIRS = frozenset({"__pycache__", "venv"})
60 def __init__(self, root_dir: str = ".", package_dirs: list[str] | None = None) -> None:
61 """Store the scan root and optional package_dirs narrowing.
63 package_dirs, when given, narrows the scan to those subdirectories of root_dir.
64 Left as None (the default), the whole of root_dir is scanned instead of assuming a
65 src/lib/test layout, since that assumption silently skipped real third-party layouts.
66 """
67 self.root_dir = root_dir
68 self.package_dirs = package_dirs
70 def find_sources(self) -> list[str]:
71 """Return every .py file under root_dir (or package_dirs, if given), sorted.
73 Files and directories whose name starts with "." are skipped, as are EXCLUDED_DIRS subdirectories.
74 The names of root_dir and package_dirs themselves are never checked.
75 """
76 path = Path(self.root_dir)
77 if not path.exists():
78 message = f"root_dir does not exist: {self.root_dir}"
79 raise FileNotFoundError(message)
80 if not path.is_dir():
81 message = f"root_dir is not a directory: {self.root_dir}"
82 raise NotADirectoryError(message)
84 roots = [path / d for d in self.package_dirs] if self.package_dirs else [path]
85 files: list[Path] = []
86 for root in roots:
87 if not root.exists():
88 continue
89 for dirpath, dirnames, filenames in root.walk():
90 # Pruning in place stops walk() from descending into skipped directories at all.
91 dirnames[:] = [name for name in dirnames if not name.startswith(".") and name not in self.SPECIAL_EXCLUDED_DIRS]
92 files.extend(dirpath / name for name in filenames if name.endswith(".py") and not name.startswith("."))
93 return sorted(str(file) for file in files)
96class BearCppScanner(CppScanner):
97 """CppScanner that generates compile_commands.json via Bear when it's missing."""
99 def __init__(self, build_dir: str = ".", compile_commands_path: str = "compile_commands.json") -> None:
100 """Store the build directory to run Bear in, alongside the compile_commands.json path."""
101 super().__init__(compile_commands_path)
102 self.build_dir = build_dir
104 def run_bear(self) -> None:
105 """Run Bear to generate compile_commands.json by wrapping the project's make invocation."""
106 # bear is resolved via PATH intentionally; build_dir isn't attacker-controlled here.
107 result = subprocess.run(["bear", "--", "make", "-C", self.build_dir], check=False) # noqa: S603, S607
108 if result.returncode != 0:
109 message = "Bear failed to run or make failed."
110 raise RuntimeError(message)
112 def find_sources(self) -> list[str]:
113 """Generate compile_commands.json via Bear if missing, then return its listed sources."""
114 if not Path(self.compile_commands_path).exists():
115 self.run_bear()
116 return super().find_sources()