[nrf fromlist] scripts: Generate and use env file for zephyr module paths

Adds a output env file that lists the paths of zephyr modules
which can be used in Kconfig files

Upstream PR #: 95049

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

Author: nordicjm

cmake/modules/kconfig.cmake

@@ -356,6 +356,7 @@ execute_process(
   ${PYTHON_EXECUTABLE}
   ${ZEPHYR_BASE}/scripts/kconfig/kconfig.py
   --zephyr-base=${ZEPHYR_BASE}
+  --env-file=${KCONFIG_BINARY_DIR}/kconfig_module_dirs.env
   ${input_configs_flags}
   ${KCONFIG_ROOT}
   ${DOTCONFIG}

scripts/ci/check_compliance.py

@@ -23,6 +23,7 @@
 import unidiff
 import yaml
 
+from dotenv import load_dotenv
 from yamllint import config, linter
 
 from junitparser import TestCase, TestSuite, JUnitXml, Skipped, Error, Failure
@@ -739,6 +740,10 @@ def parse_kconfig(self):
         self.get_modules(os.path.join(kconfiglib_dir, "Kconfig.modules"),
                          os.path.join(kconfiglib_dir, "Kconfig.sysbuild.modules"),
                          os.path.join(kconfiglib_dir, "settings_file.txt"))
+
+        # Import zephyr module paths into environmental values
+        load_dotenv(os.path.join(kconfiglib_dir, "kconfig_module_dirs.env"))
+
         # For Kconfig.dts support
         self.get_kconfig_dts(os.path.join(kconfiglib_dir, "Kconfig.dts"),
                              os.path.join(kconfiglib_dir, "settings_file.txt"))

scripts/kconfig/kconfig.py

@@ -20,6 +20,7 @@
 import re
 import sys
 import textwrap
+from dotenv import load_dotenv
 
 # Zephyr doesn't use tristate symbols. They're supported here just to make the
 # script a bit more generic.
@@ -42,6 +43,9 @@ def main():
     if args.zephyr_base:
         os.environ['ZEPHYR_BASE'] = args.zephyr_base
 
+    if args.env_file:
+        load_dotenv(args.env_file)
+
     print("Parsing " + args.kconfig_file)
     kconf = Kconfig(args.kconfig_file, warn_to_stderr=False,
                     suppress_traceback=True)
@@ -317,6 +321,8 @@ def parse_args():
                              " adjustments.")
     parser.add_argument("--zephyr-base",
                         help="Path to current Zephyr installation")
+    parser.add_argument("--env-file",
+                        help="Path to environment file to use")
     parser.add_argument("kconfig_file",
                         help="Top-level Kconfig file")
     parser.add_argument("config_out",

scripts/zephyr_module.py

@@ -386,18 +386,22 @@ def kconfig_snippet(meta, path, kconfig_file=None, blobs=False, taint_blobs=Fals
     return '\n'.join(snippet)
 
 
+def process_kconfig_module_dir(module, meta):
+    module_path = PurePath(module)
+    name_sanitized = meta['name-sanitized']
+    return f'ZEPHYR_{name_sanitized.upper()}_MODULE_DIR={module_path.as_posix()}\n'
+
+
 def process_kconfig(module, meta):
     blobs = process_blobs(module, meta)
     taint_blobs = any(b['status'] != BLOB_NOT_PRESENT for b in blobs)
     section = meta.get('build', dict())
     module_path = PurePath(module)
     module_yml = module_path.joinpath('zephyr/module.yml')
     kconfig_extern = section.get('kconfig-ext', False)
-    name_sanitized = meta['name-sanitized']
-    snippet = f'ZEPHYR_{name_sanitized.upper()}_MODULE_DIR := {module_path.as_posix()}\n'
 
     if kconfig_extern:
-        return snippet + kconfig_snippet(meta, module_path, blobs=blobs, taint_blobs=taint_blobs)
+        return kconfig_snippet(meta, module_path, blobs=blobs, taint_blobs=taint_blobs)
 
     kconfig_setting = section.get('kconfig', None)
     if not validate_setting(kconfig_setting, module):
@@ -407,10 +411,11 @@ def process_kconfig(module, meta):
 
     kconfig_file = os.path.join(module, kconfig_setting or 'zephyr/Kconfig')
     if os.path.isfile(kconfig_file):
-        return snippet + kconfig_snippet(meta, module_path, Path(kconfig_file),
-                                         blobs=blobs, taint_blobs=taint_blobs)
+        return kconfig_snippet(meta, module_path, Path(kconfig_file),
+                               blobs=blobs, taint_blobs=taint_blobs)
     else:
-        return snippet + '\n'.join(kconfig_module_opts(name_sanitized, blobs, taint_blobs)) + '\n'
+        name_sanitized = meta['name-sanitized']
+        return '\n'.join(kconfig_module_opts(name_sanitized, blobs, taint_blobs)) + '\n'
 
 
 def process_sysbuildkconfig(module, meta):
@@ -419,10 +424,9 @@ def process_sysbuildkconfig(module, meta):
     module_yml = module_path.joinpath('zephyr/module.yml')
     kconfig_extern = section.get('sysbuild-kconfig-ext', False)
     name_sanitized = meta['name-sanitized']
-    snippet = f'ZEPHYR_{name_sanitized.upper()}_MODULE_DIR := {module_path.as_posix()}\n'
 
     if kconfig_extern:
-        return snippet + kconfig_snippet(meta, module_path, sysbuild=True)
+        return kconfig_snippet(meta, module_path, sysbuild=True)
 
     kconfig_setting = section.get('sysbuild-kconfig', None)
     if not validate_setting(kconfig_setting, module):
@@ -433,10 +437,9 @@ def process_sysbuildkconfig(module, meta):
     if kconfig_setting is not None:
         kconfig_file = os.path.join(module, kconfig_setting)
         if os.path.isfile(kconfig_file):
-            return snippet + kconfig_snippet(meta, module_path, Path(kconfig_file))
+            return kconfig_snippet(meta, module_path, Path(kconfig_file))
 
-    return snippet + \
-           (f'config ZEPHYR_{name_sanitized.upper()}_MODULE\n'
+    return (f'config ZEPHYR_{name_sanitized.upper()}_MODULE\n'
             f'   bool\n'
             f'   default y\n')
 
@@ -861,6 +864,7 @@ def main():
                         help='Path to zephyr repository')
     args = parser.parse_args()
 
+    kconfig_module_dirs = ""
     kconfig = ""
     cmake = ""
     sysbuild_kconfig = ""
@@ -873,6 +877,7 @@ def main():
                             args.modules, args.extra_modules)
 
     for module in modules:
+        kconfig_module_dirs += process_kconfig_module_dir(module.project, module.meta)
         kconfig += process_kconfig(module.project, module.meta)
         cmake += process_cmake(module.project, module.meta)
         sysbuild_kconfig += process_sysbuildkconfig(
@@ -881,6 +886,16 @@ def main():
         settings += process_settings(module.project, module.meta)
         twister += process_twister(module.project, module.meta)
 
+    if args.kconfig_out or args.sysbuild_kconfig_out:
+        if args.kconfig_out:
+            kconfig_module_dirs_out = PurePath(args.kconfig_out).parent / 'kconfig_module_dirs.env'
+        elif args.sysbuild_kconfig_out:
+            kconfig_module_dirs_out = PurePath(args.sysbuild_kconfig_out).parent / \
+                                      'kconfig_module_dirs.env'
+
+        with open(kconfig_module_dirs_out, 'w', encoding="utf-8") as fp:
+            fp.write(kconfig_module_dirs)
+
     if args.kconfig_out:
         with open(args.kconfig_out, 'w', encoding="utf-8") as fp:
             fp.write(kconfig)