mirror of
https://github.com/prowler-cloud/prowler.git
synced 2026-07-04 19:21:51 +00:00
Hugo P.Brito
88 lines
2.2 KiB
Python
88 lines
2.2 KiB
Python
#!/usr/bin/env python3
|
|
"""Fail when __init__.py files are present inside test directories."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import sys
|
|
from argparse import ArgumentParser
|
|
from os import walk
|
|
from pathlib import Path
|
|
|
|
EXCLUDED_TEST_INIT_ROOTS = {
|
|
Path("tests/lib/check/fixtures/checks_folder"),
|
|
}
|
|
|
|
IGNORED_DIRECTORY_NAMES = {
|
|
".git",
|
|
".mypy_cache",
|
|
".nox",
|
|
".pytest_cache",
|
|
".tox",
|
|
".venv",
|
|
"__pycache__",
|
|
"node_modules",
|
|
"venv",
|
|
}
|
|
|
|
|
|
def is_test_init_file(path: Path) -> bool:
|
|
"""Return True when the file is a test __init__.py."""
|
|
return path.name == "__init__.py" and "tests" in path.parts
|
|
|
|
|
|
def is_excluded_test_init_file(path: Path, root: Path) -> bool:
|
|
"""Return True when the file belongs to an allowed fixture directory."""
|
|
relative_path = path.relative_to(root)
|
|
return any(
|
|
relative_path.is_relative_to(excluded) for excluded in EXCLUDED_TEST_INIT_ROOTS
|
|
)
|
|
|
|
|
|
def find_test_init_files(root: Path) -> list[Path]:
|
|
"""Return sorted __init__.py files found under test directories."""
|
|
matches = []
|
|
|
|
for current_root, directories, filenames in walk(root):
|
|
directories[:] = [
|
|
directory
|
|
for directory in directories
|
|
if directory not in IGNORED_DIRECTORY_NAMES
|
|
]
|
|
if "__init__.py" in filenames:
|
|
path = Path(current_root) / "__init__.py"
|
|
else:
|
|
continue
|
|
|
|
if is_test_init_file(path) and not is_excluded_test_init_file(path, root):
|
|
matches.append(path)
|
|
|
|
return sorted(matches)
|
|
|
|
|
|
def main(argv: list[str] | None = None) -> int:
|
|
parser = ArgumentParser(description=__doc__)
|
|
parser.add_argument(
|
|
"root",
|
|
nargs="?",
|
|
default=".",
|
|
help="Repository root to scan. Defaults to the current directory.",
|
|
)
|
|
args = parser.parse_args(argv)
|
|
|
|
root = Path(args.root).resolve()
|
|
matches = find_test_init_files(root)
|
|
|
|
if not matches:
|
|
print("No __init__.py files found in test directories.")
|
|
return 0
|
|
|
|
print("Remove __init__.py files from test directories:")
|
|
for path in matches:
|
|
print(path.relative_to(root))
|
|
|
|
return 1
|
|
|
|
|
|
if __name__ == "__main__":
|
|
sys.exit(main())
|