[nrf noup] scripts: ci: check_compliance: Check Kconfigs for enable

Allows checking sdk-nrf for Kconfig prompts that start with
"Enable" as these should not be allowed

Signed-off-by: Jamie McCrae <[email protected]>

Author: nordicjm

scripts/ci/check_compliance.py

@@ -505,9 +505,14 @@ class KconfigCheck(ComplianceTest):
     # Kconfig symbol prefix/namespace.
     CONFIG_ = "CONFIG_"
 
+    # If modules should be excluded from checks.
+    EXCLUDE_MODULES = False
+
     def run(self):
         kconf = self.parse_kconfig()
 
+        blocked_module_dirs = []
+
         self.check_top_menu_not_too_long(kconf)
         self.check_no_pointless_menuconfigs(kconf)
         self.check_no_undef_within_kconfig(kconf)
@@ -542,13 +547,33 @@ def get_modules(self, _module_dirs_file, modules_file, sysbuild_modules_file, se
         modules = [name for name in os.listdir(modules_dir) if
                    modules_dir / name / 'Kconfig']
 
-        nrf_modules_dir = ZEPHYR_BASE / Path('../nrf/modules')
+        nrf_modules_dir = (Path(ZEPHYR_BASE) / '..' / 'nrf' / 'modules').resolve()
         nrf_modules = []
+
+        # This block list contains a list of upstream Zephyr modules that should not be checked
+        # DO NOT MERGE CHANGES TO THIS WITHOUT BUILD SYSTEM AND CODE OWNER APPROVAL!
+# TODO: why is global scope of this not working
+        external_module_name_block_list = ['canopennode', 'chre', 'cmsis', 'cmsis-dsp', 'cmsis-nn',
+                                           'cmsis_6', 'edtt', 'fatfs', 'hal_st', 'hal_tdk',
+                                           'hal_wurthelektronik', 'liblc3', 'libmetal', 'littlefs',
+                                           'loramac-node', 'lvgl', 'lz4', 'mipi-sys-t', 'nanopb',
+                                           'net-tools', 'nrf_hw_models', 'open-amp', 'percepio',
+                                           'picolibc', 'segger', 'tf-m-tests', 'tinycrypt',
+                                           'uoscore-uedhoc', 'zscilib']
+
+        for module in modules:
+            if module in external_module_name_block_list:
+                self.blocked_module_dirs.append(modules_dir / module / 'Kconfig')
+
         if os.path.exists(nrf_modules_dir):
             nrf_modules = [name for name in os.listdir(nrf_modules_dir) if
                            os.path.exists(os.path.join(nrf_modules_dir, name,
                                                        'Kconfig'))]
 
+            for module in nrf_modules:
+                if module in external_module_name_block_list:
+                    self.blocked_module_dirs.append(nrf_modules_dir / module / 'Kconfig')
+
         with open(modules_file, 'r') as fp_module_file:
             content = fp_module_file.read()
 
@@ -567,6 +592,7 @@ def get_modules(self, _module_dirs_file, modules_file, sysbuild_modules_file, se
                     re.sub('[^a-zA-Z0-9]', '_', module).upper(),
                     modules_dir / module / 'Kconfig'
                 ))
+
             # Add NRF as static entry as workaround for ext Kconfig root support
             fp_module_file.write("ZEPHYR_NRF_KCONFIG = {}\n".format(
                 nrf_modules_dir / '..' / 'Kconfig.nrf'
@@ -1050,11 +1076,34 @@ def check_no_redefined_in_defconfig(self, kconf):
 
     def check_no_enable_in_boolean_prompt(self, kconf):
         # Checks that boolean's prompt does not start with "Enable...".
+# TODO: why is global scope of this not working
+        external_module_name_block_list = ['canopennode', 'chre', 'cmsis', 'cmsis-dsp', 'cmsis-nn', 'cmsis_6', 'edtt', 'fatfs', 'hal_st', 'hal_tdk', 'hal_wurthelektronik', 'liblc3', 'libmetal', 'littlefs', 'loramac-node', 'lvgl', 'lz4', 'mipi-sys-t', 'nanopb', 'net-tools', 'nrf_hw_models', 'open-amp', 'percepio', 'picolibc', 'segger', 'tf-m-tests', 'tinycrypt', 'uoscore-uedhoc', 'zscilib']
 
         for node in kconf.node_iter():
-            # skip Kconfig nodes not in-tree (will present an absolute path)
+            skip_node = False
+
+            # skip Kconfig nodes not in-tree when set to (will present an absolute path)
             if os.path.isabs(node.filename):
-                continue
+                if self.EXCLUDE_MODULES is True:
+                    continue
+
+                normalised_file_name = Path(node.filename).resolve()
+
+                for module_name in external_module_name_block_list:
+                    if normalised_file_name.full_match('**/' + module_name + '/**'):
+                        skip_node = True
+                        break
+
+                if skip_node:
+                    continue
+
+                for blocked_dir in self.blocked_module_dirs:
+                    if normalised_file_name.match(blocked_dir):
+                        skip_node = True
+                        break
+
+                if skip_node:
+                    continue
 
             # 'kconfiglib' is global
             # pylint: disable=undefined-variable
@@ -1482,6 +1531,7 @@ class KconfigBasicNoModulesCheck(KconfigBasicCheck):
     name = "KconfigBasicNoModules"
     path_hint = "<zephyr-base>"
     EMPTY_FILE_CONTENTS = "# Empty\n"
+    EXCLUDE_MODULES = True
 
     def get_modules(self, module_dirs_file, modules_file, sysbuild_modules_file, settings_file):
         with open(module_dirs_file, 'w') as fp_module_file:
@@ -1574,6 +1624,7 @@ class SysbuildKconfigBasicNoModulesCheck(SysbuildKconfigCheck, KconfigBasicNoMod
     """
     name = "SysbuildKconfigBasicNoModules"
     path_hint = "<zephyr-base>"
+    EXCLUDE_MODULES = True
 
 
 class Nits(ComplianceTest):