mirror of
https://github.com/espressif/esp-idf.git
synced 2026-10-18 19:43:17 +03:00
Jan Beran
aab610c327
Apply the ruff lint (including pyupgrade) and format fixes for the Python 3.11 target in the following areas: - tools (idf_py_actions, install_util, test_bsasm, test_idf_diag, test_idf_py, test_idf_size) - tools/ci - tools/test_apps - tools/test_build_system - tools/ldgen Findings that are not auto-fixable (long lines, a shadowed builtin, type comparisons) are fixed by hand. Also fix the typos reported by codespell and the mypy error in tools/ci/idf_pytest/utils.py that surfaced once the file was touched, and switch check_for_file_paths.py to the SPDX header (removing it from the copyright ignore list).
96 lines
3.6 KiB
Python
Executable File
96 lines
3.6 KiB
Python
Executable File
#!/usr/bin/env python
|
|
# SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
"""
|
|
Check patterns-build_components including all components files except 'test*/'
|
|
"""
|
|
|
|
import glob
|
|
import os
|
|
import subprocess
|
|
from functools import lru_cache
|
|
|
|
import yaml
|
|
from idf_ci_utils import IDF_PATH
|
|
|
|
RULES_FILE = os.path.join(IDF_PATH, '.gitlab', 'ci', 'rules.yml')
|
|
|
|
|
|
@lru_cache(1)
|
|
def get_component_git_files() -> set[str]:
|
|
output = subprocess.check_output(['git', 'ls-files', 'components/'], cwd=IDF_PATH).decode()
|
|
component_git_files = set(_l.strip() for _l in output.strip().splitlines())
|
|
assert component_git_files, 'Can not list git files'
|
|
return component_git_files
|
|
|
|
|
|
def get_component_files_from_patterns(patterns: list[str]) -> set[str]:
|
|
files: set[str] = set()
|
|
for pattern in patterns:
|
|
# NOTE: version 3.11: Added the include_hidden parameter.
|
|
# NOTE: version 3.10: Added the root_dir and dir_fd parameters.
|
|
try:
|
|
_files = set(glob.iglob(pattern, root_dir=IDF_PATH, recursive=True, include_hidden=True)) # type: ignore
|
|
except TypeError:
|
|
_files = set(glob.iglob(pattern, recursive=True))
|
|
files = files | _files
|
|
|
|
# ignore files not in git repo
|
|
files &= get_component_git_files()
|
|
return files
|
|
|
|
|
|
def get_components_test_files() -> set[str]:
|
|
patterns = [
|
|
'components/*/test/**/*',
|
|
'components/*/test_apps/**/*',
|
|
'components/*/host_test/**/*',
|
|
# other test files
|
|
'components/efuse/test_efuse_host/**/*',
|
|
'components/esp_coex/test_md5/**/*',
|
|
'components/esp_gdbstub/test_gdbstub_host/**/*',
|
|
'components/esp_system/test_eh_frame_parser/**/*',
|
|
'components/esp_wifi/test_md5/**/*',
|
|
'components/fatfs/test_fatfsgen/**/*',
|
|
'components/heap/test_multi_heap_host/**/*',
|
|
'components/nvs_flash/test_nvs_host/**/*',
|
|
'components/nvs_flash/test_apps_bootloader/**/*',
|
|
'components/partition_table/test_gen_esp32part_host/**/*',
|
|
'components/spiffs/test_spiffsgen/**/*',
|
|
]
|
|
return get_component_files_from_patterns(patterns)
|
|
|
|
|
|
def get_all_components_files() -> set[str]:
|
|
return get_component_files_from_patterns(['components/**/*'])
|
|
|
|
|
|
def main() -> None:
|
|
with open(RULES_FILE) as f:
|
|
rules = yaml.load(f.read(), Loader=yaml.FullLoader)
|
|
patterns_components = [p for p in rules['.patterns-build_components'] if p.startswith('components/')]
|
|
submodules = [p for p in rules['.patterns-submodule'] if p.startswith('components/')]
|
|
# resolve components in patterns_components
|
|
patterns_components = [f'{p}/**/*' if p in submodules else p for p in patterns_components]
|
|
|
|
# get different components files
|
|
rules_files = get_component_files_from_patterns(patterns_components)
|
|
components_test_files = get_components_test_files()
|
|
components_build_files = get_all_components_files().difference(components_test_files)
|
|
|
|
if check_test_files := components_test_files & rules_files:
|
|
# rules should not include test files
|
|
print(f'Found test files should not in .patterns-build_components: {check_test_files.pop()}')
|
|
exit(1)
|
|
if check_difference := components_build_files.difference(rules_files):
|
|
# rules should include all build files
|
|
print(f'Found components files should in .patterns-build_components but not: {check_difference.pop()}')
|
|
exit(1)
|
|
if check_difference := rules_files.difference(components_build_files):
|
|
print(f'Found components files should not in .patterns-build_components: {check_difference.pop()}')
|
|
exit(1)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|