twister: handle quotes for configuration options

Add support handling quotes for configuration options in extra args by escaping them properly instead of removing the quotes altogether. For other options in extra_args quotes are removes as usual. Add similar support in west build command also. Add a unit test to check this functionality. Signed-off-by: Chaitanya Tata <[email protected]>
zephyrproject-rtos · Sep 8, 2023 · 6b05af6 · 6b05af6
1 parent faa8bb5
commit 6b05af6
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 5 deletions.
diff --git a/scripts/pylib/twister/twisterlib/runner.py b/scripts/pylib/twister/twisterlib/runner.py
@@ -978,9 +978,15 @@ def report_out(self, results):
         sys.stdout.flush()
 
     @staticmethod
-    def cmake_assemble_args(args, handler, extra_conf_files, extra_overlay_confs,
+    def cmake_assemble_args(extra_args, handler, extra_conf_files, extra_overlay_confs,
                             extra_dtc_overlay_files, cmake_extra_args,
                             build_dir):
+        # Retain quotes around config options
+        config_options = [arg for arg in extra_args if arg.startswith("CONFIG_")]
+        args = [arg for arg in extra_args if not arg.startswith("CONFIG_")]
+
+        args_expanded = ["-D{}".format(a.replace('"', '\"')) for a in config_options]
+
         if handler.ready:
             args.extend(handler.args)
 
@@ -1003,7 +1009,7 @@ def cmake_assemble_args(args, handler, extra_conf_files, extra_overlay_confs,
             args.append("OVERLAY_CONFIG=\"%s\"" % (" ".join(overlays)))
 
         # Build the final argument list
-        args_expanded = ["-D{}".format(a.replace('"', '\"')) for a in cmake_extra_args]
+        args_expanded.extend(["-D{}".format(a.replace('"', '\"')) for a in cmake_extra_args])
         args_expanded.extend(["-D{}".format(a.replace('"', '')) for a in args])
 
         return args_expanded

diff --git a/scripts/tests/twister/test_runner.py b/scripts/tests/twister/test_runner.py
@@ -90,16 +90,17 @@ class MockHandler:
     handler.ready = True
 
     assert(ProjectBuilder.cmake_assemble_args(
-        ["basearg1"],
+        ["basearg1", "CONFIG_t=\"test\"", "SNIPPET_t=\"test\""],
         handler,
         ["a.conf;b.conf", "c.conf"],
         ["extra_overlay.conf"],
         ["x.overlay;y.overlay", "z.overlay"],
         ["cmake1=foo", "cmake2=bar"],
         "/builddir/",
     ) == [
+        "-DCONFIG_t=\"test\"",
         "-Dcmake1=foo", "-Dcmake2=bar",
-        "-Dbasearg1",
+        "-Dbasearg1", "-DSNIPPET_t=test",
         "-Dhandler_arg1", "-Dhandler_arg2",
         "-DCONF_FILE=a.conf;b.conf;c.conf",
         "-DDTC_OVERLAY_FILE=x.overlay;y.overlay;z.overlay",

diff --git a/scripts/west_commands/build.py b/scripts/west_commands/build.py
@@ -317,7 +317,11 @@ def _parse_test_item(self, test_item):
                     if data == 'extra_configs':
                         args = ["-D{}".format(arg.replace('"', '\"')) for arg in arg_list]
                     elif data == 'extra_args':
-                        args = ["-D{}".format(arg.replace('"', '')) for arg in arg_list]
+                        # Retain quotes around config options
+                        config_options = [arg for arg in arg_list if arg.startswith("CONFIG_")]
+                        non_config_options = [arg for arg in arg_list if not arg.startswith("CONFIG_")]
+                        args = ["-D{}".format(a.replace('"', '\"')) for a in config_options]
+                        args.extend(["-D{}".format(arg.replace('"', '')) for arg in non_config_options])
                     elif data == 'extra_conf_files':
                         extra_conf_files.extend(arg_list)
                         continue