tools: check for incorrect case used in Kconfig filenames

tools/check_kconfigs.py

@@ -22,8 +22,8 @@ import re
 import argparse
 from io import open
 
-# regular expression search object for matching Kconfig files
+# regular expression for matching Kconfig files
-RE_KCONFIG = re.compile(r'^Kconfig(?:\.projbuild)?$')
+RE_KCONFIG = r'^Kconfig(?:\.projbuild)?$'
 
 # ouput file with suggestions will get this suffix
 OUTPUT_SUFFIX = '.new'
@@ -358,47 +358,51 @@ def main():
     check_ignore_dirs = default_path is not None and os.path.abspath(args.directory) == os.path.abspath(default_path)
 
     for root, dirnames, filenames in os.walk(args.directory):
-        for filename in [f for f in filenames if RE_KCONFIG.search(f)]:
+        for filename in filenames:
             full_path = os.path.join(root, filename)
             path_in_idf = os.path.relpath(full_path, args.directory)
-            if check_ignore_dirs and path_in_idf.startswith(IGNORE_DIRS):
+            if re.search(RE_KCONFIG, filename):
-                print('{}: Ignored'.format(path_in_idf))
+                if check_ignore_dirs and path_in_idf.startswith(IGNORE_DIRS):
-                ignore_counter += 1
+                    print('{}: Ignored'.format(path_in_idf))
-                continue
+                    ignore_counter += 1
-            suggestions_full_path = full_path + OUTPUT_SUFFIX
+                    continue
-            with open(full_path, 'r', encoding='utf-8') as f, \
+                suggestions_full_path = full_path + OUTPUT_SUFFIX
-                    open(suggestions_full_path, 'w', encoding='utf-8', newline='\n') as f_o, \
+                with open(full_path, 'r', encoding='utf-8') as f, \
-                    LineRuleChecker(path_in_idf) as line_checker, \
+                        open(suggestions_full_path, 'w', encoding='utf-8', newline='\n') as f_o, \
-                    IndentAndNameChecker(path_in_idf, debug=args.verbose) as indent_and_name_checker:
+                        LineRuleChecker(path_in_idf) as line_checker, \
-                try:
+                        IndentAndNameChecker(path_in_idf, debug=args.verbose) as indent_and_name_checker:
-                    for line_number, line in enumerate(f, start=1):
+                    try:
-                        try:
+                        for line_number, line in enumerate(f, start=1):
-                            for checker in [line_checker, indent_and_name_checker]:
+                            try:
-                                checker.process_line(line, line_number)
+                                for checker in [line_checker, indent_and_name_checker]:
-                            # The line is correct therefore we echo it to the output file
+                                    checker.process_line(line, line_number)
-                            f_o.write(line)
+                                # The line is correct therefore we echo it to the output file
-                        except InputError as e:
+                                f_o.write(line)
-                            print(e)
+                            except InputError as e:
-                            failure = True
+                                print(e)
-                            f_o.write(e.suggested_line)
+                                failure = True
-                except UnicodeDecodeError:
+                                f_o.write(e.suggested_line)
-                    raise ValueError("The encoding of {} is not Unicode.".format(path_in_idf))
+                    except UnicodeDecodeError:
+                        raise ValueError("The encoding of {} is not Unicode.".format(path_in_idf))
 
-            if failure:
+                if failure:
-                print('{} has been saved with suggestions for resolving the issues. Please note that the suggestions '
+                    print('{} has been saved with suggestions for resolving the issues. Please note that the '
-                      'can be wrong and you might need to re-run the checker several times for solving all issues.'
+                          'suggestions can be wrong and you might need to re-run the checker several times '
-                      ''.format(path_in_idf + OUTPUT_SUFFIX))
+                          'for solving all issues'.format(path_in_idf + OUTPUT_SUFFIX))
-                print('Please fix the errors and run {} for checking the correctness of '
+                    print('Please fix the errors and run {} for checking the correctness of '
-                      'Kconfigs.'.format(os.path.relpath(os.path.abspath(__file__), args.directory)))
+                          'Kconfigs.'.format(os.path.relpath(os.path.abspath(__file__), args.directory)))
-                sys.exit(1)
+                    sys.exit(1)
-            else:
+                else:
-                success_couter += 1
+                    success_couter += 1
-                print('{}: OK'.format(path_in_idf))
+                    print('{}: OK'.format(path_in_idf))
-                try:
+                    try:
-                    os.remove(suggestions_full_path)
+                        os.remove(suggestions_full_path)
-                except Exception:
+                    except Exception:
-                    # not a serious error is when the file cannot be deleted
+                        # not a serious error is when the file cannot be deleted
-                    print('{} cannot be deleted!'.format(suggestions_full_path))
+                        print('{} cannot be deleted!'.format(suggestions_full_path))
+            elif re.search(RE_KCONFIG, filename, re.IGNORECASE):
+                # On Windows Kconfig files are working with different cases!
+                raise ValueError('Incorrect filename of {}. The case should be "Kconfig"!'.format(path_in_idf))
 
     if ignore_counter > 0:
         print('{} files have been ignored.'.format(ignore_counter))