esp-idf/tools/ci/check_deprecated_kconfigs.py

111 lines
3.7 KiB
Python
Raw Normal View History

#!/usr/bin/env python
#
# SPDX-FileCopyrightText: 2019-2023 Espressif Systems (Shanghai) CO LTD
2022-06-15 10:46:55 -04:00
# SPDX-License-Identifier: Apache-2.0
from __future__ import print_function, unicode_literals
import argparse
import os
import sys
from io import open
2022-06-28 13:00:12 -04:00
from typing import Set, Tuple
from idf_ci_utils import get_submodule_dirs
# FILES_TO_CHECK used as "startswith" pattern to match sdkconfig.defaults variants
FILES_TO_CHECK = ('sdkconfig.ci', 'sdkconfig.defaults')
# ignored directories (makes sense only when run on IDF_PATH)
# Note: IGNORE_DIRS is a tuple in order to be able to use it directly with the startswith() built-in function which
# accepts tuples but no lists.
2022-06-28 13:00:12 -04:00
IGNORE_DIRS: Tuple = (
)
def _parse_path(path: 'os.PathLike[str]', sep: str=None) -> Set:
ret = set()
with open(path, 'r', encoding='utf-8') as f:
for line in f:
line = line.strip()
if not line.startswith('#') and len(line) > 0:
ret.add(line.split(sep)[0])
return ret
def valid_directory(path: str) -> str:
if not os.path.isdir(path):
raise argparse.ArgumentTypeError('{} is not a valid directory!'.format(path))
return path
2022-06-28 13:00:12 -04:00
def check() -> int:
parser = argparse.ArgumentParser(description='Kconfig options checker')
parser.add_argument('files', nargs='*',
help='Kconfig files')
parser.add_argument('--includes', '-d', nargs='*',
help='Extra paths for recursively searching Kconfig files. (for example $IDF_PATH)',
type=valid_directory)
parser.add_argument('--exclude-submodules', action='store_true',
help='Exclude submodules')
args = parser.parse_args()
success_counter = 0
failure_counter = 0
ignore_counter = 0
deprecated_options = set()
ignore_dirs = IGNORE_DIRS
if args.exclude_submodules:
for submodule in get_submodule_dirs(full_path=True):
ignore_dirs = ignore_dirs + tuple(submodule)
files = [os.path.abspath(file_path) for file_path in args.files]
if args.includes:
for directory in args.includes:
for root, dirnames, filenames in os.walk(directory):
for filename in filenames:
full_path = os.path.join(root, filename)
if filename.startswith(FILES_TO_CHECK):
files.append(full_path)
elif filename == 'sdkconfig.rename':
deprecated_options |= _parse_path(full_path)
for full_path in files:
if full_path.startswith(ignore_dirs):
print('{}: Ignored'.format(full_path))
ignore_counter += 1
continue
used_options = _parse_path(full_path, '=')
used_deprecated_options = deprecated_options & used_options
if len(used_deprecated_options) > 0:
print('{}: The following options are deprecated: {}'
.format(full_path, ', '.join(used_deprecated_options)))
failure_counter += 1
else:
print('{}: OK'.format(full_path))
success_counter += 1
if ignore_counter > 0:
print('{} files have been ignored.'.format(ignore_counter))
if success_counter > 0:
print('{} files have been successfully checked.'.format(success_counter))
if failure_counter > 0:
print('{} files have errors. Please take a look at the log.'.format(failure_counter))
return 1
if not files:
print('WARNING: no files specified. Please specify files or use '
'"--includes" to search Kconfig files recursively')
return 0
2022-06-28 13:00:12 -04:00
def main() -> None:
sys.exit(check())
if __name__ == '__main__':
2022-06-28 13:00:12 -04:00
main()