mirror of
https://fuchsia.googlesource.com/third_party/github.com/pylint-dev/pylint
synced 2024-09-21 16:19:21 +00:00
85 lines
2.9 KiB
Python
85 lines
2.9 KiB
Python
# Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
|
|
# For details: https://github.com/PyCQA/pylint/blob/main/LICENSE
|
|
# Copyright (c) https://github.com/PyCQA/pylint/blob/main/CONTRIBUTORS.txt
|
|
|
|
import os
|
|
from pathlib import Path
|
|
from typing import List, Set, Union
|
|
|
|
from pylint.testutils.functional.test_file import FunctionalTestFile
|
|
|
|
REASONABLY_DISPLAYABLE_VERTICALLY = 48
|
|
"""'Wet finger' number of files that are reasonable to display by an IDE."""
|
|
SHOULD_BE_IN_THE_SAME_DIRECTORY = 5
|
|
"""'Wet finger' as in 'in my settings there are precisely this many'."""
|
|
|
|
IGNORED_PARENT_DIRS = {
|
|
"deprecated_relative_import",
|
|
"ext",
|
|
"regression",
|
|
"regression_02",
|
|
}
|
|
"""Direct parent directories that should be ignored."""
|
|
|
|
IGNORED_PARENT_PARENT_DIRS = {
|
|
"docparams",
|
|
"deprecated_relative_import",
|
|
"ext",
|
|
}
|
|
"""Parents of direct parent directories that should be ignored."""
|
|
|
|
|
|
def get_functional_test_files_from_directory(
|
|
input_dir: Union[Path, str]
|
|
) -> List[FunctionalTestFile]:
|
|
"""Get all functional tests in the input_dir."""
|
|
suite = []
|
|
|
|
_check_functional_tests_structure(Path(input_dir))
|
|
|
|
for dirpath, _, filenames in os.walk(input_dir):
|
|
if dirpath.endswith("__pycache__"):
|
|
continue
|
|
for filename in filenames:
|
|
if filename != "__init__.py" and filename.endswith(".py"):
|
|
suite.append(FunctionalTestFile(dirpath, filename))
|
|
return suite
|
|
|
|
|
|
def _check_functional_tests_structure(directory: Path) -> None:
|
|
"""Check if test directories follow correct file/folder structure."""
|
|
# Ignore underscored directories
|
|
if Path(directory).stem.startswith("_"):
|
|
return
|
|
|
|
files: Set[Path] = set()
|
|
dirs: Set[Path] = set()
|
|
|
|
# Collect all subdirectories and files in directory
|
|
for file_or_dir in directory.iterdir():
|
|
if file_or_dir.is_file():
|
|
if file_or_dir.suffix == ".py" and not file_or_dir.stem.startswith("_"):
|
|
files.add(file_or_dir)
|
|
elif file_or_dir.is_dir():
|
|
dirs.add(file_or_dir)
|
|
_check_functional_tests_structure(file_or_dir)
|
|
|
|
assert len(files) <= REASONABLY_DISPLAYABLE_VERTICALLY, (
|
|
f"{directory} contains too many functional tests files "
|
|
+ f"({len(files)} > {REASONABLY_DISPLAYABLE_VERTICALLY})."
|
|
)
|
|
|
|
for file in files:
|
|
possible_dir = file.parent / file.stem.split("_")[0]
|
|
assert not possible_dir.exists(), f"{file} should go in {possible_dir}."
|
|
|
|
# Exclude some directories as they follow a different structure
|
|
if (
|
|
not len(file.parent.stem) == 1 # First letter subdirectories
|
|
and file.parent.stem not in IGNORED_PARENT_DIRS
|
|
and file.parent.parent.stem not in IGNORED_PARENT_PARENT_DIRS
|
|
):
|
|
assert file.stem.startswith(
|
|
file.parent.stem
|
|
), f"{file} should not go in {file.parent}"
|