esp-idf/tools/ci/check_executables.py

#!/usr/bin/env python
#
# SPDX-FileCopyrightText: 2020-2022 Espressif Systems (Shanghai) CO LTD
# SPDX-License-Identifier: Apache-2.0

import argparse
import os
import sys
from typing import Iterable, List

try:
    from idf_ci_utils import is_executable
except ImportError:
    sys.path.append(os.path.join(os.path.dirname(__file__)))

    from idf_ci_utils import is_executable


def _strip_each_item(iterable: Iterable) -> List:
    res = []
    for item in iterable:
        if item:
            res.append(item.strip())
    return res


IDF_PATH = os.getenv('IDF_PATH', os.getcwd())
EXECUTABLE_LIST_FN = os.path.join(IDF_PATH, 'tools/ci/executable-list.txt')
known_executables = _strip_each_item(open(EXECUTABLE_LIST_FN).readlines())


def check_executable_list() -> int:
    ret = 0
    for index, fn in enumerate(known_executables):
        if not os.path.exists(os.path.join(IDF_PATH, fn)):
            print('{}:{} {} not exists. Please remove it manually'.format(EXECUTABLE_LIST_FN, index + 1, fn))
            ret = 1
    return ret


def check_executables(files: List) -> int:
    ret = 0
    for fn in files:
        fn_executable = is_executable(fn)
        fn_in_list = fn in known_executables
        if fn_executable and not fn_in_list:
            print('"{}" is not in {}'.format(fn, EXECUTABLE_LIST_FN))
            ret = 1
        if not fn_executable and fn_in_list:
            print('"{}" is not executable but is in {}'.format(fn, EXECUTABLE_LIST_FN))
            ret = 1
    return ret


def check() -> int:
    parser = argparse.ArgumentParser()
    parser.add_argument('--action', choices=['executables', 'list'], required=True,
                        help='if "executables", pass all your executables to see if it\'s in the list.'
                             'if "list", check if all items on your list exist')
    parser.add_argument('filenames', nargs='*', help='Filenames to check.')
    args = parser.parse_args()

    if args.action == 'executables':
        ret = check_executables(args.filenames)
    elif args.action == 'list':
        ret = check_executable_list()
    else:
        raise ValueError

    return ret


if __name__ == '__main__':
    sys.exit(check())